SCR_PlaceableItemComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_PlaceableItemComponentClass

Functions
SCR_PlaceableItemComponentClass ScriptComponentClass	GetPlacementType ()
bool	CanAttachToDynamicObject ()
	Returns true if it should be possible to attach this object to dynamic object like f.e. vehicle.
float	GetMaxAllowedTilt ()
EPhysicsLayerDefs	GetIgnoredPhysicsLayers ()
	Returns physics layer mask that can be used to determin which layers should be ignored.
SCR_ECharacterDistanceMeasurementMethod	GetDistanceMeasurementMethod ()
	Returns preferred Measurement method.
int	GetIgnoredComponents (notnull out array< typename > outIgnoredComponents)
	Returns physics layer mask that can be used to determin which layers should be ignored.
ResourceName	GetPreviewObjectResource ()
float	GetMaxPlacementDistance ()
bool	IsForwardFacingAwayFromPlayer ()
bool	CanAttachToTheSurfaceEntity ()
bool	CanBeForcePlaced ()
void	ValidateIgnoredComponents ()
	Removes unwanted types from ignored components list.
bool	GetForwardAwayFromPlayer ()
bool	GetAttachPlacedItemToTheSurfaceEntity ()
bool	GetCanBeForcedPlaced ()
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)
bool	OverrideSpaceValidation (notnull SCR_ItemPlacementComponent caller, inout vector transform[4], out ENotification cantPlaceReason)
void	OverridePreviewTransform (notnull SCR_ItemPlacementComponent caller, inout vector transform[4])
bool	OverrideStartPlaceAction (notnull SCR_ItemPlacementComponent caller, out bool skipItemUsage=false)
bool	OverrideOnPlacingEnded (notnull SCR_ItemPlacementComponent caller)
void	OverrideAfterItemPlaced (notnull SCR_ItemPlacementComponent caller, notnull IEntity item, bool success, bool equipNext)
bool	OverrideAutoEquipMechanism (out ScriptedInventoryOperationCallback callBackHolder, notnull SCR_ItemPlacementComponent caller, IEntity placedItem, bool autoEquipNext)
VObject	GetPreviewVobject ()
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Editable Mine.
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)

Variables
bool	m_bCanAttachToDynamicObject
float	m_fMaxAllowedTilt
EPhysicsLayerDefs	m_eIgnoredPhysicsLayers
ref array< string >	m_aIgnoredComponents
SCR_ECharacterDistanceMeasurementMethod	m_eMeasurementMethod
ResourceName	m_sPreviewObject
float	m_fMaxPlacementDistance
SCR_EPlacementType	m_ePlacementType
bool	m_bForwardAwayFromPlayer
bool	m_bAttachPlacedItemToTheSurfaceEntity
bool	m_bCanBeForcedPlaced
ref array< typename >	m_aIgnoredComponentTypes = {}
bool	m_bValidated

Function Documentation

CanAttachToDynamicObject()

bool CanAttachToDynamicObject ( )

protected

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

Definition at line 188 of file SCR_PlaceableItemComponent.c.

CanAttachToTheSurfaceEntity()

bool GetPlacementType::CanAttachToTheSurfaceEntity ( )

protected

Definition at line 252 of file SCR_PlaceableItemComponent.c.

CanBeForcePlaced()

bool GetPlacementType::CanBeForcePlaced ( )

protected

Definition at line 258 of file SCR_PlaceableItemComponent.c.

GetAttachPlacedItemToTheSurfaceEntity()

bool GetAttachPlacedItemToTheSurfaceEntity

(

)

Returns

Definition at line 182 of file SCR_PlaceableItemComponent.c.

GetCanBeForcedPlaced()

bool GetCanBeForcedPlaced

(

)

Returns

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

Definition at line 193 of file SCR_PlaceableItemComponent.c.

GetDistanceMeasurementMethod()

SCR_ECharacterDistanceMeasurementMethod GetDistanceMeasurementMethod ( )

protected

Returns preferred Measurement method.

Definition at line 209 of file SCR_PlaceableItemComponent.c.

GetForwardAwayFromPlayer()

bool GetForwardAwayFromPlayer

(

)

Returns

Definition at line 171 of file SCR_PlaceableItemComponent.c.

GetIgnoredComponents()

int GetIgnoredComponents ( notnull out array< typename > outIgnoredComponents )

protected

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

Removes unwanted types from ignored components list.

Definition at line 216 of file SCR_PlaceableItemComponent.c.

GetIgnoredPhysicsLayers()

EPhysicsLayerDefs GetIgnoredPhysicsLayers ( )

protected

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

Definition at line 202 of file SCR_PlaceableItemComponent.c.

GetMaxAllowedTilt()

float GetPlacementType::GetMaxAllowedTilt ( )

protected

Definition at line 195 of file SCR_PlaceableItemComponent.c.

GetMaxPlacementDistance()

float GetMaxPlacementDistance ( )

protected

Returns

Definition at line 234 of file SCR_PlaceableItemComponent.c.

GetPlacementType()

SCR_EPlacementType GetPlacementType

(

)

Returns

Definition at line 1 of file SCR_PlaceableItemComponent.c.

GetPreviewObjectResource()

ResourceName GetPlacementType::GetPreviewObjectResource ( )

protected

Definition at line 228 of file SCR_PlaceableItemComponent.c.

GetPreviewVobject()

VObject GetPreviewVobject

(

)

Returns

Definition at line 266 of file SCR_PlaceableItemComponent.c.

IsForwardFacingAwayFromPlayer()

bool GetPlacementType::IsForwardFacingAwayFromPlayer ( )

protected

Definition at line 246 of file SCR_PlaceableItemComponent.c.

OverrideAfterItemPlaced()

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()

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()

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()

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()

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 692 of file SCR_CampaignBuildingGadgetToolComponent.c.

OverrideSpaceValidation()

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()

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.

RplLoad()

override bool RplLoad ( ScriptBitReader reader )

protected

Definition at line 397 of file SCR_PlaceableItemComponent.c.

RplSave()

override bool RplSave ( ScriptBitWriter writer )

protected

Definition at line 379 of file SCR_PlaceableItemComponent.c.

ValidateIgnoredComponents()

void GetPlacementType::ValidateIgnoredComponents ( )

protected

Removes unwanted types from ignored components list.

Definition at line 265 of file SCR_PlaceableItemComponent.c.

Variable Documentation

m_aIgnoredComponents

ref array<string> m_aIgnoredComponents

protected

Definition at line 160 of file SCR_PlaceableItemComponent.c.

m_aIgnoredComponentTypes

ref array<typename> m_aIgnoredComponentTypes = {}

protected

Definition at line 183 of file SCR_PlaceableItemComponent.c.

m_bAttachPlacedItemToTheSurfaceEntity

bool m_bAttachPlacedItemToTheSurfaceEntity

protected

Definition at line 178 of file SCR_PlaceableItemComponent.c.

m_bCanAttachToDynamicObject

bool m_bCanAttachToDynamicObject

protected

Definition at line 151 of file SCR_PlaceableItemComponent.c.

m_bCanBeForcedPlaced

bool m_bCanBeForcedPlaced

protected

Definition at line 181 of file SCR_PlaceableItemComponent.c.

m_bForwardAwayFromPlayer

bool m_bForwardAwayFromPlayer

protected

Definition at line 175 of file SCR_PlaceableItemComponent.c.

m_bValidated

bool m_bValidated

protected

Definition at line 184 of file SCR_PlaceableItemComponent.c.

m_eIgnoredPhysicsLayers

EPhysicsLayerDefs m_eIgnoredPhysicsLayers

protected

Definition at line 157 of file SCR_PlaceableItemComponent.c.

m_eMeasurementMethod

SCR_ECharacterDistanceMeasurementMethod m_eMeasurementMethod

protected

Definition at line 163 of file SCR_PlaceableItemComponent.c.

m_ePlacementType

SCR_EPlacementType m_ePlacementType

protected

Definition at line 172 of file SCR_PlaceableItemComponent.c.

m_fMaxAllowedTilt

float m_fMaxAllowedTilt

protected

Definition at line 154 of file SCR_PlaceableItemComponent.c.

m_fMaxPlacementDistance

float m_fMaxPlacementDistance

protected

Definition at line 169 of file SCR_PlaceableItemComponent.c.

m_sPreviewObject

ResourceName m_sPreviewObject

protected

Definition at line 166 of file SCR_PlaceableItemComponent.c.