SCR_PlaceableItemComponentClass Class Reference

Inheritance diagram for SCR_PlaceableItemComponentClass:

Protected Member Functions
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 ()
SCR_EPlacementType	GetPlacementType ()
bool	IsForwardFacingAwayFromPlayer ()
bool	CanAttachToTheSurfaceEntity ()
bool	CanBeForcePlaced ()
void	ValidateIgnoredComponents ()
	Removes unwanted types from ignored components list.

Protected Attributes
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

Detailed Description

Definition at line 2 of file SCR_PlaceableItemComponent.c.

Member Function Documentation

CanAttachToDynamicObject()

bool SCR_PlaceableItemComponentClass::CanAttachToDynamicObject ( )

inlineprotected

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

Definition at line 42 of file SCR_PlaceableItemComponent.c.

CanAttachToTheSurfaceEntity()

bool SCR_PlaceableItemComponentClass::CanAttachToTheSurfaceEntity ( )

inlineprotected

Definition at line 106 of file SCR_PlaceableItemComponent.c.

CanBeForcePlaced()

bool SCR_PlaceableItemComponentClass::CanBeForcePlaced ( )

inlineprotected

Definition at line 112 of file SCR_PlaceableItemComponent.c.

GetDistanceMeasurementMethod()

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponentClass::GetDistanceMeasurementMethod ( )

inlineprotected

Returns preferred Measurement method.

Definition at line 63 of file SCR_PlaceableItemComponent.c.

GetIgnoredComponents()

int SCR_PlaceableItemComponentClass::GetIgnoredComponents ( notnull out array< typename > outIgnoredComponents )

inlineprotected

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

Definition at line 70 of file SCR_PlaceableItemComponent.c.

GetIgnoredPhysicsLayers()

EPhysicsLayerDefs SCR_PlaceableItemComponentClass::GetIgnoredPhysicsLayers ( )

inlineprotected

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

Definition at line 56 of file SCR_PlaceableItemComponent.c.

GetMaxAllowedTilt()

float SCR_PlaceableItemComponentClass::GetMaxAllowedTilt ( )

inlineprotected

Definition at line 49 of file SCR_PlaceableItemComponent.c.

GetMaxPlacementDistance()

float SCR_PlaceableItemComponentClass::GetMaxPlacementDistance ( )

inlineprotected

Definition at line 88 of file SCR_PlaceableItemComponent.c.

GetPlacementType()

SCR_EPlacementType SCR_PlaceableItemComponentClass::GetPlacementType ( )

inlineprotected

Definition at line 94 of file SCR_PlaceableItemComponent.c.

GetPreviewObjectResource()

ResourceName SCR_PlaceableItemComponentClass::GetPreviewObjectResource ( )

inlineprotected

Definition at line 82 of file SCR_PlaceableItemComponent.c.

IsForwardFacingAwayFromPlayer()

bool SCR_PlaceableItemComponentClass::IsForwardFacingAwayFromPlayer ( )

inlineprotected

Definition at line 100 of file SCR_PlaceableItemComponent.c.

ValidateIgnoredComponents()

void SCR_PlaceableItemComponentClass::ValidateIgnoredComponents ( )

inlineprotected

Removes unwanted types from ignored components list.

Definition at line 119 of file SCR_PlaceableItemComponent.c.

Member Data Documentation

m_aIgnoredComponents

ref array<string> SCR_PlaceableItemComponentClass::m_aIgnoredComponents

protected

Definition at line 14 of file SCR_PlaceableItemComponent.c.

m_aIgnoredComponentTypes

ref array<typename> SCR_PlaceableItemComponentClass::m_aIgnoredComponentTypes = {}

protected

Definition at line 37 of file SCR_PlaceableItemComponent.c.

m_bAttachPlacedItemToTheSurfaceEntity

bool SCR_PlaceableItemComponentClass::m_bAttachPlacedItemToTheSurfaceEntity

protected

Definition at line 32 of file SCR_PlaceableItemComponent.c.

m_bCanAttachToDynamicObject

bool SCR_PlaceableItemComponentClass::m_bCanAttachToDynamicObject

protected

Definition at line 5 of file SCR_PlaceableItemComponent.c.

m_bCanBeForcedPlaced

bool SCR_PlaceableItemComponentClass::m_bCanBeForcedPlaced

protected

Definition at line 35 of file SCR_PlaceableItemComponent.c.

m_bForwardAwayFromPlayer

bool SCR_PlaceableItemComponentClass::m_bForwardAwayFromPlayer

protected

Definition at line 29 of file SCR_PlaceableItemComponent.c.

m_bValidated

bool SCR_PlaceableItemComponentClass::m_bValidated

protected

Definition at line 38 of file SCR_PlaceableItemComponent.c.

m_eIgnoredPhysicsLayers

EPhysicsLayerDefs SCR_PlaceableItemComponentClass::m_eIgnoredPhysicsLayers

protected

Definition at line 11 of file SCR_PlaceableItemComponent.c.

m_eMeasurementMethod

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponentClass::m_eMeasurementMethod

protected

Definition at line 17 of file SCR_PlaceableItemComponent.c.

m_ePlacementType

SCR_EPlacementType SCR_PlaceableItemComponentClass::m_ePlacementType

protected

Definition at line 26 of file SCR_PlaceableItemComponent.c.

m_fMaxAllowedTilt

float SCR_PlaceableItemComponentClass::m_fMaxAllowedTilt

protected

Definition at line 8 of file SCR_PlaceableItemComponent.c.

m_fMaxPlacementDistance

float SCR_PlaceableItemComponentClass::m_fMaxPlacementDistance

protected

Definition at line 23 of file SCR_PlaceableItemComponent.c.

m_sPreviewObject

ResourceName SCR_PlaceableItemComponentClass::m_sPreviewObject

protected

Definition at line 20 of file SCR_PlaceableItemComponent.c.

---

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

• scripts/Game/Components/SCR_PlaceableItemComponent.c