SCR_DeployablePlaceableItemComponent Interface Reference

Inheritance diagram for SCR_DeployablePlaceableItemComponent:

Public Member Functions
void	SetPlacingGadget (SCR_CampaignBuildingGadgetToolComponent gadget)
override bool	GetForwardAwayFromPlayer ()
override float	GetMaxAllowedTilt ()
override bool	OverrideSpaceValidation (notnull SCR_ItemPlacementComponent caller, inout vector transform[4], out ENotification cantPlaceReason)
	Method used to execute custom space validation.
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.
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.
override void	OverrideAfterItemPlaced (notnull SCR_ItemPlacementComponent caller, notnull IEntity item, bool success, bool equipNext)
	Method called after item was succesfully removed from clients inventory.
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.
Public Member Functions inherited from SCR_PlaceableItemComponent
SCR_EPlacementType	GetPlacementType ()
float	GetMaxPlacementDistance ()
bool	GetAttachPlacedItemToTheSurfaceEntity ()
bool	GetCanBeForcedPlaced ()
VObject	GetPreviewVobject ()
bool	CanAttachToDynamicObject ()
	Returns true if it should be possible to attach this object to dynamic object like f.e. vehicle.
EPhysicsLayerDefs	GetIgnoredPhysicsLayers ()
	Returns physics layer mask that can be used to determin which layers should be ignored.
int	GetIgnoredComponents (notnull out array< TypeName > outIgnoredComponents)
	Removes unwanted types from ignored components list.
override void	OnPostInit (IEntity owner)
SCR_ECharacterDistanceMeasurementMethod	GetDistanceMeasurementMethod ()
	Returns preferred Measurement method.

Protected Attributes
SCR_CampaignBuildingGadgetToolComponent	m_PlacingGadget
	Gadget which is used to place this item, this will automatically reset when this item will be placed with that gadget.
Protected Attributes inherited from SCR_PlaceableItemComponent
ResourceName	m_sPreviewObject
float	m_fMaxPlacementDistance
SCR_EPlacementType	m_ePlacementType
bool	m_bForwardAwayFromPlayer
bool	m_bAttachPlacedItemToTheSurfaceEntity
bool	m_bCanBeForcedPlaced

Additional Inherited Members
Static Public Member Functions inherited from SCR_PlaceableItemComponent
static float	GetDistanceFromCharacter (notnull ChimeraCharacter char, vector destination, SCR_ECharacterDistanceMeasurementMethod method=SCR_ECharacterDistanceMeasurementMethod.FROM_EYES)
Protected Member Functions inherited from SCR_PlaceableItemComponent
override void	EOnInit (IEntity owner)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)

Member Function Documentation

GetForwardAwayFromPlayer()

override bool SCR_DeployablePlaceableItemComponent.GetForwardAwayFromPlayer

(

)

Returns

Implements SCR_PlaceableItemComponent.

GetMaxAllowedTilt()

override float SCR_DeployablePlaceableItemComponent.GetMaxAllowedTilt

(

)

Implements SCR_PlaceableItemComponent.

OverrideAfterItemPlaced()

override void SCR_DeployablePlaceableItemComponent.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

Implements SCR_PlaceableItemComponent.

OverrideAutoEquipMechanism()

override bool SCR_DeployablePlaceableItemComponent.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

Implements SCR_PlaceableItemComponent.

OverrideOnPlacingEnded()

override bool SCR_DeployablePlaceableItemComponent.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

Implements SCR_PlaceableItemComponent.

OverrideSpaceValidation()

override bool SCR_DeployablePlaceableItemComponent.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

Implements SCR_PlaceableItemComponent.

OverrideStartPlaceAction()

override bool SCR_DeployablePlaceableItemComponent.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

Implements SCR_PlaceableItemComponent.

SetPlacingGadget()

void SCR_DeployablePlaceableItemComponent.SetPlacingGadget

(

SCR_CampaignBuildingGadgetToolComponent

gadget

)

Parameters

[in]

gadget

Member Data Documentation

m_PlacingGadget

SCR_CampaignBuildingGadgetToolComponent SCR_DeployablePlaceableItemComponent.m_PlacingGadget

protected

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

---

The documentation for this interface was generated from the following file:

• Game/Components/SCR_DeployablePlaceableItemComponent.c