Inheritance diagram for SCR_PlaceableItemComponent:

Public Member Functions
SCR_EPlacementType	GetPlacementType ()

float	GetMaxPlacementDistance ()

bool	GetForwardAwayFromPlayer ()

bool	GetAttachPlacedItemToTheSurfaceEntity ()

bool	GetCanBeForcedPlaced ()

float	GetMaxAllowedTilt ()

bool	OverrideSpaceValidation (notnull SCR_ItemPlacementComponent caller, inout vector transform[4], out ENotification cantPlaceReason)
	Method used to execute custom space validation.

bool	OverrideStartPlaceAction (notnull SCR_ItemPlacementComponent caller, out bool skipItemUsage=false)
	Method executed when player confirms item placement by pressing SCR_ItemPlacementComponent.ACTION_NAME_PLACEMENT.

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.

void	OverrideAfterItemPlaced (notnull SCR_ItemPlacementComponent caller, notnull IEntity item, bool success, bool equipNext)
	Method called after item was succesfully removed from clients inventory.

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.

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.

Static Public Member Functions
static float	GetDistanceFromCharacter (notnull ChimeraCharacter char, vector destination, SCR_ECharacterDistanceMeasurementMethod method=SCR_ECharacterDistanceMeasurementMethod.FROM_EYES)

Protected Member Functions
override void	EOnInit (IEntity owner)

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

Protected Attributes
ResourceName	m_sPreviewObject

float	m_fMaxPlacementDistance

SCR_EPlacementType	m_ePlacementType

bool	m_bForwardAwayFromPlayer

bool	m_bAttachPlacedItemToTheSurfaceEntity

bool	m_bCanBeForcedPlaced

Member Function Documentation

◆ CanAttachToDynamicObject()

bool SCR_PlaceableItemComponent.CanAttachToDynamicObject ( )

Returns true if it should be possible to attach this object to dynamic object like f.e. vehicle.

◆ EOnInit()

override void SCR_PlaceableItemComponent.EOnInit ( IEntity owner )

protected

◆ GetAttachPlacedItemToTheSurfaceEntity()

bool SCR_PlaceableItemComponent.GetAttachPlacedItemToTheSurfaceEntity ( )

Returns

◆ GetCanBeForcedPlaced()

bool SCR_PlaceableItemComponent.GetCanBeForcedPlaced ( )

Returns: true if item can be forced to be placed at specified position, despite not having enough space for it

◆ GetDistanceFromCharacter()

static float SCR_PlaceableItemComponent.GetDistanceFromCharacter	(	notnull ChimeraCharacter char	,
		vector	destination,
		SCR_ECharacterDistanceMeasurementMethod	method = SCR_ECharacterDistanceMeasurementMethod::FROM_EYES )

static

Parameters

[in]	char
[in]	destination
[in]	method

Returns

◆ GetDistanceMeasurementMethod()

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponent.GetDistanceMeasurementMethod ( )

Returns preferred Measurement method.

◆ GetForwardAwayFromPlayer()

bool SCR_PlaceableItemComponent.GetForwardAwayFromPlayer ( )

Returns

Implemented in SCR_DeployablePlaceableItemComponent.

◆ GetIgnoredComponents()

int SCR_PlaceableItemComponent.GetIgnoredComponents ( notnull out array< TypeName > outIgnoredComponents )

Removes unwanted types from ignored components list.

◆ GetIgnoredPhysicsLayers()

EPhysicsLayerDefs SCR_PlaceableItemComponent.GetIgnoredPhysicsLayers ( )

Returns physics layer mask that can be used to determin which layers should be ignored.

◆ GetMaxAllowedTilt()

float SCR_PlaceableItemComponent.GetMaxAllowedTilt ( )

Implemented in SCR_DeployablePlaceableItemComponent.

◆ GetMaxPlacementDistance()

float SCR_PlaceableItemComponent.GetMaxPlacementDistance ( )

Returns

◆ GetPlacementType()

SCR_EPlacementType SCR_PlaceableItemComponent.GetPlacementType ( )

Returns

◆ GetPreviewVobject()

VObject SCR_PlaceableItemComponent.GetPreviewVobject ( )

Returns

◆ OnPostInit()

override void SCR_PlaceableItemComponent.OnPostInit ( IEntity owner )

◆ OverrideAfterItemPlaced()

void SCR_PlaceableItemComponent.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

Implemented in SCR_DeployablePlaceableItemComponent.

◆ OverrideAutoEquipMechanism()

bool SCR_PlaceableItemComponent.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

Implemented in SCR_DeployablePlaceableItemComponent.

◆ OverrideOnPlacingEnded()

bool SCR_PlaceableItemComponent.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

Implemented in SCR_DeployablePlaceableItemComponent.

◆ OverrideSpaceValidation()

bool SCR_PlaceableItemComponent.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

Implemented in SCR_DeployablePlaceableItemComponent.

◆ OverrideStartPlaceAction()

bool SCR_PlaceableItemComponent.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

Implemented in SCR_DeployablePlaceableItemComponent.

◆ RplLoad()

override bool SCR_PlaceableItemComponent.RplLoad ( ScriptBitReader reader )

protected

◆ RplSave()

override bool SCR_PlaceableItemComponent.RplSave ( ScriptBitWriter writer )

protected

Member Data Documentation

◆ m_bAttachPlacedItemToTheSurfaceEntity

bool SCR_PlaceableItemComponent.m_bAttachPlacedItemToTheSurfaceEntity

protected

◆ m_bCanBeForcedPlaced

bool SCR_PlaceableItemComponent.m_bCanBeForcedPlaced

protected

◆ m_bForwardAwayFromPlayer

bool SCR_PlaceableItemComponent.m_bForwardAwayFromPlayer

protected

◆ m_ePlacementType

SCR_EPlacementType SCR_PlaceableItemComponent.m_ePlacementType

protected

◆ m_fMaxPlacementDistance

float SCR_PlaceableItemComponent.m_fMaxPlacementDistance

protected

◆ m_sPreviewObject

ResourceName SCR_PlaceableItemComponent.m_sPreviewObject

protected

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

Game/Components/SCR_PlaceableItemComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CanAttachToDynamicObject()

◆ EOnInit()

◆ GetAttachPlacedItemToTheSurfaceEntity()

◆ GetCanBeForcedPlaced()

◆ GetDistanceFromCharacter()

◆ GetDistanceMeasurementMethod()

◆ GetForwardAwayFromPlayer()

◆ GetIgnoredComponents()

◆ GetIgnoredPhysicsLayers()

◆ GetMaxAllowedTilt()

◆ GetMaxPlacementDistance()

◆ GetPlacementType()

◆ GetPreviewVobject()

◆ OnPostInit()

◆ OverrideAfterItemPlaced()

◆ OverrideAutoEquipMechanism()

◆ OverrideOnPlacingEnded()

◆ OverrideSpaceValidation()

◆ OverrideStartPlaceAction()

◆ RplLoad()

◆ RplSave()

Member Data Documentation

◆ m_bAttachPlacedItemToTheSurfaceEntity

◆ m_bCanBeForcedPlaced

◆ m_bForwardAwayFromPlayer

◆ m_ePlacementType

◆ m_fMaxPlacementDistance

◆ m_sPreviewObject