EntitySlotInfo Interface Reference

Adds ability to attach an object to a slot. More...

Inheritance diagram for EntitySlotInfo:

Public Member Functions
ScriptInvokerEntity	GetAttachedEntityInvoker ()
ScriptInvokerEntity	GetDetachedEntityInvoker ()
proto external bool	IsEnabled ()
proto external IEntity	GetAttachedEntity ()
	Returns currently attached entity or null if none.
proto external string	GetSourceName ()
	Returns the name of the EntitySlotInfo defined in the array of slots.
proto external void	SetAdditiveTransformLS (vector matLS[4])
	Updates attached entity's transformation by combining provided transformation with slot predefined local transformation Once new entity is attached to slot provided transformation is discarded and predifined local transformation is used instead.
proto external void	OverrideTransformLS (vector matLS[4])
	Overrides local transformation of entity Once new entity is attached to slot provided transformation is discarded and predifined local transformation is used instead.
proto external void	DetachEntity (bool physicalChange=true)
	Detaches entity from this slot info (if any)
proto external void	AttachEntity (IEntity entity)
	Attaches provided entity to this slot info Deletes previously attached entity (if any)
void	OnAttachedEntity (IEntity entity)
	Runs every time an entity is attached to the slot.
void	OnDetachedEntity (IEntity entity)
	Runs every time an entity is detached from the slot.

Static Public Member Functions
static EntitySlotInfo	GetSlotInfo (notnull IEntity entity)
	Checks whether provided entity has parent and if so, tries to find a slot which it would belong to.
static void	GetSlotInfos (notnull IEntity entity, inout notnull array< EntitySlotInfo > slotInfos)
	Get slots of the passed entity

Detailed Description

Adds ability to attach an object to a slot.

Member Function Documentation

AttachEntity()

proto external void EntitySlotInfo.AttachEntity

(

IEntity

entity

)

Attaches provided entity to this slot info Deletes previously attached entity (if any)

Parameters

childEntity

The entity to attach

DetachEntity()

proto external void EntitySlotInfo.DetachEntity

(

bool

physicalChange = true

)

Detaches entity from this slot info (if any)

Parameters

physicalChange

Do update hierarchy?

GetAttachedEntity()

proto external IEntity EntitySlotInfo.GetAttachedEntity

(

)

Returns currently attached entity or null if none.

GetAttachedEntityInvoker()

ScriptInvokerEntity EntitySlotInfo.GetAttachedEntityInvoker

(

)

GetDetachedEntityInvoker()

ScriptInvokerEntity EntitySlotInfo.GetDetachedEntityInvoker

(

)

GetSlotInfo()

static EntitySlotInfo EntitySlotInfo.GetSlotInfo ( notnull IEntity  entity )

static

Checks whether provided entity has parent and if so, tries to find a slot which it would belong to.

Parameters

entity

The slotted entity to get parent slot info for

Returns

Returns Returns slot info of slotted entity

GetSlotInfos()

static void EntitySlotInfo.GetSlotInfos ( notnull IEntity  entity, inout notnull array< EntitySlotInfo >  slotInfos  )

static

Get slots of the passed entity

Parameters

entity	The parent entity to get slot infos for
slotInfos	Slot infos array to return slot infos to

Returns

Returns Returns children slot infos of entity

GetSourceName()

proto external string EntitySlotInfo.GetSourceName

(

)

Returns the name of the EntitySlotInfo defined in the array of slots.

IsEnabled()

proto external bool EntitySlotInfo.IsEnabled

(

)

OnAttachedEntity()

void EntitySlotInfo.OnAttachedEntity

(

IEntity

entity

)

Runs every time an entity is attached to the slot.

Implemented in SCR_EmissiveLightSurfaceSlot, and SCR_WheelSlotInfo.

OnDetachedEntity()

void EntitySlotInfo.OnDetachedEntity

(

IEntity

entity

)

Runs every time an entity is detached from the slot.

Implemented in SCR_EmissiveLightSurfaceSlot, and SCR_WheelSlotInfo.

OverrideTransformLS()

proto external void EntitySlotInfo.OverrideTransformLS

(

vector

matLS[4]

)

Overrides local transformation of entity Once new entity is attached to slot provided transformation is discarded and predifined local transformation is used instead.

SetAdditiveTransformLS()

proto external void EntitySlotInfo.SetAdditiveTransformLS

(

vector

matLS[4]

)

Updates attached entity's transformation by combining provided transformation with slot predefined local transformation Once new entity is attached to slot provided transformation is discarded and predifined local transformation is used instead.

---

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

• Game/generated/EntitySlotInfo.c