func_useableladder

func_useableladder is a point entity available in all Source games.

Entity description

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

 Note: This entity is non-functional in Counter-Strike: Source and Left 4 Dead. Use func_ladder instead.

 Bug: 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. Requires further investigation.

Keyvalues

Start (point0) <vector>

Ladder start point

End (point1) <vector>

Ladder end point

Start Disabled (StartDisabled) <choices>

Should the ladder spawn disabled ? Default value is 0

• 0: No
• 1: Yes

Surface properties (ladderSurfaceProperties) <string>

Parentname:

Parent (parentname) <targetname>

Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist> (in all games since )

Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.

Script think function (thinkfunction) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

 Note: Try to avoid expensive operations in this function, as it may cause performance problems.

Flags

• 1 : Fake Ladder

Inputs

EnableDisable:

Enable

Disable

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

Parentname:

SetParent <string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and its children from the world.

 Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.

AddOutput <string>

Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>

FireUser1 to FireUser4

Fire the OnUser outputs; see User Inputs and Outputs.

Use  !FGD

Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.

RunScriptFile <script> (in all games since )

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <string> (in all games since )

Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.

 Bug: In , the code is executed in the script scope of the entity that fires the output, not the one receiving the input.

 Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.

CallScriptFunction <string> (in all games since ) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !FGD

Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.

SetLocalAngles <angles> (in all games since ) !FGD

Set this entity's angles.

Outputs

OnPlayerGotOnLadder

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

OnPlayerGotOffLadder

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

Targetname:

OnUser1 to OnUser4

These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.

OnKilled  (only in )

This output fires when the entity is killed and removed from the game.

Issues

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

Usable ladder has a gap between itself and brush.

See also

• info_ladder_dismount - An entity used to specify ladder auto-dismount points.
• ladder_simple - A prefab containing a simple ladder setup
• Working Ladders - A wiki tutorial on how to construct ladders
• A tutorial bsp and map for constructing ladders