Working Ladders

From Valve Developer Community
Revision as of 19:36, 14 July 2021 by MrFunreal (talk | contribs) (Brush Ladders: added note about ladders turning into one ladder, if they thouch)
Jump to: navigation, search
Español Русский 简体中文 한국어
Level Design

In all Source Engine games (with a few exceptions) a ladder in-game consists of the prop or brush that the player perceives as the ladder, and the invisible entity/brush system in front of it that actually makes the ladder climbable. This gives the illusion that the player is climbing the visible ladder, where in fact he is scaling the invisible ladder entity/brush just in front of it. To create the visible ladder, you can either use:

  • prop_static entity with a ladder model (like models\props_c17\metalladder001.mdl)
  • brush with a ladder texture (like metal/metalladder001a).

The ladder's climbing system is created depends on which Source game it is intended for. Ladders in Half-Life 2 and Half-Life 2: Deathmatch are created a little differently than those of earlier games to provide better control for the level designer and player alike, while ladders in Counter-Strike: Source and Day of Defeat: Source are implemented pretty much the same way as the older games.

Ladder entities

Creating the ladder

Used in: Half-Life 2 Half-Life 2, SiN Episodes Sin Episodes, Dark Messiah of Might and Magic Dark Messiah of Might and Magic

To create a ladder you must define the volume in which the player will move through space while on the ladder. This volume can be defined in two ways: Using the func_useableladder entity, or using the deprecated func_ladderendpoint entity (which is only briefly described below to provide understanding of the workings of older maps).

The func_useableladder entity can be divided into two sub entities: a starting point and an ending point (See Fig. 1a). Their positions can be typed into the keyvalue fields, or more typically the ladder volume can be defined using the visual ladder tool, by dragging its center circle that is visible when the entity is selected (See Fig. 1b). Using this tool you can drag the start and end point of the ladder into appropriate positions in the 2D view. The ladder's start and ending point may be of arbitrary orientation and length (See Fig. 1c). Simply pull the endpoints where you want them and the player will move between these points while on the ladder.

Fig. 1a - Ladder points
Fig. 1b - Changing orientation
Fig. 1c - Slanted ladder points

As you place the endpoints, make sure that you place them a couple of units away from the visible ladder brush (or any other brush or model) because if any four sides of the ladder volume is even touching against a surface of a brush or a model, this will make that part of the ladder volume unclimbable.

The now obsolete func_ladderendpoint entity just consists of a single endpoint. A ladder volume is created by linking two func_ladderendpoints together using their properties. A ladder volume is created between two func_ladderendpoints by naming one of the endpoints and having the other endpoint point to its name in its Other value. (It is not necessary for the second endpoint to point back at the first as stated in properties.)


Fig. 2 - Dismounts

Along with the volume of movement, you can also provide dismount points for the ladder (See Fig. 2) to allow easier and more controlled dismounts. These points are marked using the info_ladder_dismount entity. While next to and facing one of these markers, the player can press his use key to dismount to the position of the marker (typically when ladders run between more than two floors). If he has reached one of the ends of the ladder, he can also simply walk off the ladder by facing one of the markers nearby and walking forward. You can use multiple info_ladder_dismount markers for each dismount place to provide more directions to exit the ladder in.

To avoid possible confusion between nearby ladders using different dismount markers, each info_ladder_dismount entity has a property value called LadderName which can be used to contain the name of the ladder it belongs to.

Like the ladder volume, the dismount points must be free of obstruction and allow the player to stand at their position without intersecting solid world geometry.

In-game testing

Once you have created your ladders, you can compile your map and test them. If you wish, you can also display the ladder entities in-game along with some debug information by opening the console and typing sv_showladders 1 to enable this, and then load or reload (by typing restart) the map you wish to view. This will show you all the start and end points of the ladders (func_useableladder and func_ladderendpoint entities), as well as the dismount points (info_ladder_dismount entities) (See Fig. 3a), and can help you determine if these entities are set up properly, if ladder entities are colliding with solid world geometry or the prop model of the ladder itself (See Fig. 3b), and which func_ladderendpoint entities connect to each other.

Fig. 3a - In-game visualization
Fig. 3b - Endpoint stuck in floor

How ladders work in-game

The safest way to mount a ladder is to approach its invisible ladder volume and within reaching distance press the use key. This will automatically position you on the ladder. (You can also walk into the ladder volume, with greater risk of missing it and falling down any hole.)

To dismount a ladder you can always either jump off, or press your use key. If the ladder has info_ladder_dismounts, you can also simply walk off from its endpoints, and pressing your use key while next to and facing an info_ladder_dismount will also allow more controlled dismounts anywhere on the ladder.

Brush Ladders

Object brush based ladders

Fig. 4 - func_ladder textured with tools/toolsinvisibleladder in front of a prop_static ladder.

Used in: Left 4 Dead Left 4 Dead, Left 4 Dead 2 Left 4 Dead 2, Counter-Strike: Source Counter-Strike: Source, Day of Defeat: Source Day of Defeat: Source, Garry's Mod Garry's Mod, <Vampire: The Masquerade - Bloodlines> Vampire: The Masquerade - Bloodlines, The Ship The Ship

Create another brush in front of the object/brush you want to be climbable, as close as you can to it, but without touching it. Make sure that the face is the same width/height as the climbable object. Assign the material tools/toolsinvisibleladder to this brush and then tie it to an entity CTRL+T. Select func_ladder from the Object Properties dialog. You now have a climbable face which is in front of the object/brush. While on a ladder in CS:S your shooting accuracy will be significantly reduced.

Note.png Note:  Infected only Ladders in the Left 4 Dead Series uses the 'tools/climb_versus' texture, see also how to create ladders for the Left 4 Dead series.
Note.png Note:  Vampire Bloodlines ladders use the 'tools/toolsinvisible' texture.
Note.png Note:  Similar ladders are used in <Half-Life> Half-Life, but here the 'AAATRIGGER' texture is used instead.
Note.png Note:  Ladders that touch each other will be turned into one single ladder. If you need to block navigation on one ladder, it would block navigation on both ladders. Add gaps between ladders.
Bug.png Bug: If the brush crosses any water surfaces, the player interacting with it can exhibit weird behavior, teleport the player while in the water to the end of the ladder. This has been encountered in a partial submersion of the ladder brush.

To do: In what circumstances exactly does it happen?

Non-object brush based ladders

func_detail textured with 'tools/toolsinvisibleladder' in front of a prop_static ladder.

Used in: Counter-Strike: Global Offensive Counter-Strike: Global Offensive

This ladder type is set up and works in exactly the same way as object brush ladders, but shall not be tied to a func_ladder entity or it will make the ladder non-existent in-game. To make it, create a brush in front of the object/brush you want to be climbable, as close as you can to it, but without touching it.

Make sure that the face is the same width/height as the climbable object and then assign the material 'tools/toolsinvisibleladder' to this brush. You now have a climbable face which is in front of the object/brush. No other setup is required for your ladder to work in game.

Note.png Note:  Since 'tools/toolsinvisibleladder' still cuts visleafs, make sure to tie the ladder brush to func_detail.
Tip.png Tip:  'tools/toolsinvisibleladder' will make the entire brush act like a ladder, even if it is only on a single face of the brush. Other faces of the brush will still show their textures in game.

Brush based ladder workaround

Used in: Team Fortress 2 Team Fortress 2, Portal 2 Portal 2

Some Source games does not support the standard ladder entity, however it is possible to fake a ladder by creating a very narrow staircase.

To start off make a prop_static and set the world model to models/props_c17/metalladder002.mdl. If you not happy with this particular model, open the model browser and type in ladder to search for some, there are a few different models. You can also make a ladder prop out of brushes or use the ladder texture on a single brush face.

Next, create a brush 16 units high using the player clip texture. Use the player clip bushes to make a stack of blocks making sure each higher block is one unit "behind" the lower one. The players will climb these 16 unit high brushes as stairs. Too keep them from going too far out once you reach the bottom select the no clip blocks group them and then compress them as long as the top step sticks out past where the prop ends and each block still has a small lip it will work just fine. There you have it a good looking climbable ladder.

Video Showing how to create it: TF2 mapping: Ladders in TF2

To do:  Add an image showing how to create this type of ladder in hammer for TF2.

Optimizing Ladders

The ladder props, like every prop_static, default to using VPhysics for collision detection, which will provide more detailed physics collisions, but in some cases this might not be preferable. In multiplayer maps and very resource demanding maps using VPhysics props costs precious resources, and you might want to sacrifice good physics to avoid potential lag. Here are some good methods to minimize resource cost:

  • If the ladder is for HL2 or HL2:DM, and the ladder is straight, the best method depends on whether somebody is going to be able to shoot through the ladder. If they are not (like if the ladder is against a wall) you could simply change the Collisions keyvalue to Use Bounding Box. If they are, you could change the keyvalue to Not Solid and place an invisible Clip (toolsclip) to detect collision with it instead.
  • If you are creating a slanting ladder for HL2 or HL2:DM, a bounding box will not rotate with the prop, and will obstruct the climbing system, in which case you are better off making the ladder prop Not Solid and place an invisible, rotated Clip (toolsclip) or Player Clip (toolsplayerclip) textured brush alongside the ladder (depending on whether or not somebody is going to be able to shoot through it).
  • If the ladder is for a CS:S or DoD:S map, you could change the Collisions keyvalue to Not Solid and make the func_ladder brush cover the ladder prop, rotating it if necessary.

In multiplayer maps it's also an understood expectation to be able to move freely parallel to the surface that a ladder covers. When it comes to brush based ladders, you can get away with turning the ladder brush into a non-solid func_brush to avoid players getting temporarily "stuck" against the side of the ladder, but when it comes to prop ladders, they are often too protruding from the wall to make a player standing inside a ladder believable. In that case you are probably better off using two Player Clip textured wedges at the sides of the prop, guiding the player to the front of the prop.

If nothing else, you could turn a brush ladder into a func_detail to avoid unnecessary brush leafs.

See also