SCR_PlaceableItemComponent Interface Reference

Inheritance diagram for SCR_PlaceableItemComponent:

Public Member Functions
SCR_EPlacementType	GetPlacementType ()
float	GetMaxPlacementDistance ()
VObject	GetPreviewVobject ()
bool	CanAttachToDynamicObject ()
	Returns true if it should be possible to attach this object to dynamic object like f.e. vehicle.
bool	CanBeAttachedWhileAngled ()
	Returns true if this object is meant to be attached no matter what will be it is rotation when it will be attached.
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

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.

CanBeAttachedWhileAngled()

bool SCR_PlaceableItemComponent.CanBeAttachedWhileAngled

(

)

Returns true if this object is meant to be attached no matter what will be it is rotation when it will be attached.

EOnInit()

override void SCR_PlaceableItemComponent.EOnInit ( IEntity owner )

protected

GetDistanceFromCharacter()

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

static

GetDistanceMeasurementMethod()

SCR_ECharacterDistanceMeasurementMethod SCR_PlaceableItemComponent.GetDistanceMeasurementMethod

(

)

Returns preferred Measurement method.

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.

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

)

RplLoad()

override bool SCR_PlaceableItemComponent.RplLoad ( ScriptBitReader reader )

protected

RplSave()

override bool SCR_PlaceableItemComponent.RplSave ( ScriptBitWriter writer )

protected

Member Data Documentation

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