This article's documentation is for anything that uses the Source engine. Click here for more information.

func_useableladder

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)

func_useableladder is a point entity available in all Source Source games.

Class hierarchy
CFuncLadder
CBaseEntity
func_ladder.cpp

It is a Half-Life 2-style ladder. Handles player auto mount/unmount, as well as +use to get onto the ladder.

Note.pngNote:This entity is non-functional in Counter-Strike: Source Counter-Strike: Source and Left 4 Dead series Left 4 Dead series. Use func_ladder instead.
Warning.pngRisk of Confusion:This is a point entity despite the name starting with func_ (which is usually used for brush entities).
Icon-Bug.pngBug:There seems to be a bug where mounting or dismounting a ladder within a trigger volume will cause the trigger to fire outputs as if the player left and re-entered the volume. Seems to be because of how dismounting works, as it technically gives the player noclip temporarily, which makes the player not touch the trigger.  [todo tested in?]

Issues

You should be sure, that ladder is not in contact with your brush if using it for ladder representation, otherwise it won't work.

Usable ladder has a gap between itself and brush.

Keyvalues

Name (targetname) <string>
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Start (point0) <vector>
Ladder start point
End (point1) <vector>
Ladder end point
Surface properties (ladderSurfaceProperties) <string>
Start Disabled (StartDisabled) <boolean>
Should the ladder spawn disabled ? Default value is 0
  • 0: No
  • 1: Yes

Flags

Fake Ladder : [1]

Ladder serving for mount check which still fires the OnPlayerGotOnLadder output but won't actually put the player on the ladder
PlacementTip.pngExample:Used in Half-Life 2 d2_coast_04 for the ladder leading to operable crane and uses OnPlayerGotOnLadder output to put player inside the crane

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

OnPlayerGotOnLadder
Fired whenever a player gets on this ladder. !caller = player
OnPlayerGotOffLadder
Fired whenever a player gets off this ladder. !caller = player

See also