LadderComponent Interface Reference

Inheritance diagram for LadderComponent:

Public Member Functions
proto external bool	IsAbove (vector pPositionWS)
	Check if the position is above the ladder.
proto external void	SetEnabledEntry (ELadderDoorState entryState)
	Enable or disable the top front entry of the ladder.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Member Function Documentation

IsAbove()

proto external bool LadderComponent.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

SetEnabledEntry()

proto external void LadderComponent.SetEnabledEntry

(

ELadderDoorState

entryState

)

Enable or disable the top front entry of the ladder.

Use when for design reasons you need to allow the associated DoorComponent's door to be entered even when closed, or vice-versa, prevent from being entered even when open. This call is synchronized in MP, and only has effect on the server.

Parameters

entryState

Desired state.

---

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

• Game/generated/Buildings/LadderComponent.c