Buildings

Data Structures
class	BaseSlotComponentClass
class	ClimbingDataComponentClass
class	DoorSlotComponentClass
class	LadderComponentClass
class	SlotBoneMappingObject

Functions
BaseSlotComponentClass GameComponentClass	GetSlotInfo ()
	Returns the current slot info. More...
proto external IEntity	GetAttachedEntity ()
	Returns the current attached entity. More...
event void	OnAttachedEntity (IEntity ent)
	Runs every time an entity is attached to the slot. More...
event void	OnDetachedEntity (IEntity ent)
	Runs every time an entity is detached from the slot. More...
ClimbingDataComponentClass GenericComponentClass	CanClimbOver ()
	Returns true if the owner of this component can be climbed. More...
LadderComponentClass GameComponentClass	IsAbove (vector pPositionWS)
proto external void	SetEnabledEntry (bool frontTop)

Detailed Description

Function Documentation

CanClimbOver()

ClimbingDataComponentClass GenericComponentClass CanClimbOver

(

)

Returns true if the owner of this component can be climbed.

GetAttachedEntity()

proto external IEntity GetAttachedEntity

(

)

Returns the current attached entity.

GetSlotInfo()

BaseSlotComponentClass GameComponentClass GetSlotInfo

(

)

Returns the current slot info.

IsAbove()

LadderComponentClass GameComponentClass IsAbove

(

vector

pPositionWS

)

Check if the position is above the ladder.

Parameters

pPositionWS

Position in world space which will be checked

Returns

Return true if the position is above the ladder

OnAttachedEntity()

event void OnAttachedEntity

(

IEntity

ent

)

Runs every time an entity is attached to the slot.

Definition at line 10 of file SCR_WheelSlotInfo.c.

OnDetachedEntity()

event void OnDetachedEntity

(

IEntity

ent

)

Runs every time an entity is detached from the slot.

Definition at line 22 of file SCR_WheelSlotInfo.c.

SetEnabledEntry()

proto external void SetEnabledEntry

(

bool

frontTop

)

Enable or disable the top front entry of the ladder.

Parameters

frontTop

Desired state of entry.