SCR_PlaceableItemComponentClass Interface Reference

Inheritance diagram for SCR_PlaceableItemComponentClass:

Public 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

Member Function Documentation

CanAttachToDynamicObject()

bool SCR_PlaceableItemComponentClass.CanAttachToDynamicObject

(

)

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

CanAttachToTheSurfaceEntity()

bool SCR_PlaceableItemComponentClass.CanAttachToTheSurfaceEntity

(

)

CanBeForcePlaced()

bool SCR_PlaceableItemComponentClass.CanBeForcePlaced

(

)

GetDistanceMeasurementMethod()

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponentClass.GetDistanceMeasurementMethod

(

)

Returns preferred Measurement method.

GetIgnoredComponents()

int SCR_PlaceableItemComponentClass.GetIgnoredComponents

(

notnull out array< TypeName >

outIgnoredComponents

)

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

GetIgnoredPhysicsLayers()

EPhysicsLayerDefs SCR_PlaceableItemComponentClass.GetIgnoredPhysicsLayers

(

)

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

GetMaxAllowedTilt()

float SCR_PlaceableItemComponentClass.GetMaxAllowedTilt

(

)

GetMaxPlacementDistance()

float SCR_PlaceableItemComponentClass.GetMaxPlacementDistance

(

)

GetPlacementType()

SCR_EPlacementType SCR_PlaceableItemComponentClass.GetPlacementType

(

)

GetPreviewObjectResource()

ResourceName SCR_PlaceableItemComponentClass.GetPreviewObjectResource

(

)

IsForwardFacingAwayFromPlayer()

bool SCR_PlaceableItemComponentClass.IsForwardFacingAwayFromPlayer

(

)

ValidateIgnoredComponents()

void SCR_PlaceableItemComponentClass.ValidateIgnoredComponents

(

)

Removes unwanted types from ignored components list.

Member Data Documentation

m_aIgnoredComponents

ref array<string> SCR_PlaceableItemComponentClass.m_aIgnoredComponents

protected

m_aIgnoredComponentTypes

ref array<TypeName> SCR_PlaceableItemComponentClass.m_aIgnoredComponentTypes = {}

protected

m_bAttachPlacedItemToTheSurfaceEntity

bool SCR_PlaceableItemComponentClass.m_bAttachPlacedItemToTheSurfaceEntity

protected

m_bCanAttachToDynamicObject

bool SCR_PlaceableItemComponentClass.m_bCanAttachToDynamicObject

protected

m_bCanBeForcedPlaced

bool SCR_PlaceableItemComponentClass.m_bCanBeForcedPlaced

protected

m_bForwardAwayFromPlayer

bool SCR_PlaceableItemComponentClass.m_bForwardAwayFromPlayer

protected

m_bValidated

bool SCR_PlaceableItemComponentClass.m_bValidated

protected

m_eIgnoredPhysicsLayers

EPhysicsLayerDefs SCR_PlaceableItemComponentClass.m_eIgnoredPhysicsLayers

protected

m_eMeasurementMethod

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponentClass.m_eMeasurementMethod

protected

m_ePlacementType

SCR_EPlacementType SCR_PlaceableItemComponentClass.m_ePlacementType

protected

m_fMaxAllowedTilt

float SCR_PlaceableItemComponentClass.m_fMaxAllowedTilt

protected

m_fMaxPlacementDistance

float SCR_PlaceableItemComponentClass.m_fMaxPlacementDistance

protected

m_sPreviewObject

ResourceName SCR_PlaceableItemComponentClass.m_sPreviewObject

protected

---

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

• Game/Components/SCR_PlaceableItemComponent.c