SCR_DeployablePlaceableItemComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_DeployablePlaceableItemComponentClass

Functions
void	SetPlacingGadget (SCR_CampaignBuildingGadgetToolComponent gadget)
override bool	GetForwardAwayFromPlayer ()
override float	GetMaxAllowedTilt ()
override bool	OverrideIsSurfaceValid (notnull SCR_ItemPlacementComponent caller, out ENotification cantPlaceReason, IEntity surfaceEnt, vector worldPosition, vector surfaceNorm, int nodeIndex, int colliderIndex, SurfaceProperties surfaceProps, string surfaceMaterial, string colliderName)
override bool	OverrideSpaceValidation (notnull SCR_ItemPlacementComponent caller, inout vector transform[4], out ENotification cantPlaceReason)
override void	OverridePreviewTransform (notnull SCR_ItemPlacementComponent caller, inout vector transform[4])
override bool	OverrideStartPlaceAction (notnull SCR_ItemPlacementComponent caller, out bool skipItemUsage=false)
override bool	OverrideOnPlacingEnded (notnull SCR_ItemPlacementComponent caller)
override void	OverrideAfterItemPlaced (notnull SCR_ItemPlacementComponent caller, notnull IEntity item, bool success, bool equipNext)
override bool	OverrideAutoEquipMechanism (out ScriptedInventoryOperationCallback callBackHolder, notnull SCR_ItemPlacementComponent caller, IEntity placedItem, bool autoEquipNext)

Variables
SCR_DeployablePlaceableItemComponentClass	m_PlacingGadget
	Gadget which is used to place this item, this will automatically reset when this item will be placed with that gadget.

Function Documentation

GetForwardAwayFromPlayer()

override bool GetForwardAwayFromPlayer

(

)

Definition at line 19 of file SCR_DeployablePlaceableItemComponent.c.

GetMaxAllowedTilt()

override float GetMaxAllowedTilt

(

)

Definition at line 32 of file SCR_DeployablePlaceableItemComponent.c.

OverrideAfterItemPlaced()

override void OverrideAfterItemPlaced	(	notnull SCR_ItemPlacementComponent	caller,
		notnull IEntity	item,
		bool	success,
		bool	equipNext )

Method called after item was succesfully removed from clients inventory

Parameters

[in]	caller
[in]	item
[in]	succes
[in]	equipNext

Definition at line 85 of file SCR_DeployablePlaceableItemComponent.c.

OverrideAutoEquipMechanism()

override bool OverrideAutoEquipMechanism	(	out ScriptedInventoryOperationCallback	callBackHolder,
		notnull SCR_ItemPlacementComponent	caller,
		IEntity	placedItem,
		bool	autoEquipNext )

Override this in order to add a custom callback that is going to be triggered after item is removed from this client inventory

Parameters

[out]	callBackHolder
[in]	caller	component which called this method
[in]	placedItem
[in]	autoEquipNext	bool value representing player settings for automatic equipping of next place

Returns

true if default mechanism should not be used, otherwise false

Definition at line 95 of file SCR_DeployablePlaceableItemComponent.c.

OverrideIsSurfaceValid()

override bool OverrideIsSurfaceValid	(	notnull SCR_ItemPlacementComponent	caller,
		out ENotification	cantPlaceReason,
		IEntity	surfaceEnt,
		vector	worldPosition,
		vector	surfaceNorm,
		int	nodeIndex,
		int	colliderIndex,
		SurfaceProperties	surfaceProps,
		string	surfaceMaterial,
		string	colliderName )

Method used to execute custom validation of the surface entity

Parameters

[in]	caller
[out]	cantPlaceReason

Returns

true if custom space validation was performed, otherwise false

Definition at line 41 of file SCR_DeployablePlaceableItemComponent.c.

OverrideOnPlacingEnded()

override bool OverrideOnPlacingEnded

(

notnull SCR_ItemPlacementComponent

caller

)

Method called after item placement was already requested, but depending on the client it may have not yet finished

Parameters

[in]

caller

Returns

false if placement should be finished by disabling the preview, if custom functionality is reqired then return true

Definition at line 79 of file SCR_DeployablePlaceableItemComponent.c.

OverridePreviewTransform()

override void OverridePreviewTransform	(	notnull SCR_ItemPlacementComponent	caller,
		inout vector	transform[4] )

Method used to override the position and rotation of the preview

Parameters

[in]	caller
[in,out]	transform	pointer containing rotation and position at which item preivew will be shown, and from which the space validation will be done

Definition at line 59 of file SCR_DeployablePlaceableItemComponent.c.

OverrideSpaceValidation()

override bool OverrideSpaceValidation	(	notnull SCR_ItemPlacementComponent	caller,
		inout vector	transform[4],
		out ENotification	cantPlaceReason )

Method used to execute custom space validation

Parameters

[in]	caller
[in,out]	transform	pointer containing rotation and position at which item will be placed. This position has already applied offset of 1% of its up vector (1cm)
[out]	cantPlaceReason

Returns

true if custom space validation was performed, otherwise false

Definition at line 50 of file SCR_DeployablePlaceableItemComponent.c.

OverrideStartPlaceAction()

override bool OverrideStartPlaceAction	(	notnull SCR_ItemPlacementComponent	caller,
		out bool	skipItemUsage = false )

Method executed when player confirms item placement by pressing SCR_ItemPlacementComponent.ACTION_NAME_PLACEMENT

Parameters

[in]	caller
[out]	skipItemUsage	true if game should not try to player item usage animation and immidietly proceed to SCR_ItemPlacementComponent.OnPlacingEnded

Returns

true if result of this mehtod should be used

Definition at line 68 of file SCR_DeployablePlaceableItemComponent.c.

SetPlacingGadget()

void SetPlacingGadget

(

SCR_CampaignBuildingGadgetToolComponent

gadget

)

Parameters

[in]

gadget

Definition at line 13 of file SCR_DeployablePlaceableItemComponent.c.

Variable Documentation

m_PlacingGadget

SCR_DeployablePlaceableItemComponentClass m_PlacingGadget

Gadget which is used to place this item, this will automatically reset when this item will be placed with that gadget.