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

Func ladder: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{{Source topicon}}
{{Source topicon}}
{{TabsBar}}
{{TabsBar}}
{{This is a|brush entity|internal=1|name=func_ladder}}
{{Ent not in fgd|except={{css}}{{dods}}{{l4d}}{{l4d2}}{{csgo}}}}
{{This is a|brush entity|internal=1|name=func_ladder}}  
__NOTOC__
== Differences ==
=== Before {{l4d|4}} ===
When [[VBSP]] compiles the map, it converts <kbd>func_ladder</kbd> brushes into regular world brushes with added [[CONTENTS_LADDER|ladder contents]], and an {{ent|info_ladder}} entity is created with KVs indicating the bounding box of the ladder.


When [[VBSP]] compiles the map, it converts {{code|func_ladder}} brushes into regular world brushes with [[Contents flags|ladder contents]], and an {{ent|info_ladder}} entity is created with KVs indicating the bounding box of the ladder.
Because this type of <code>info_ladder</code> exists only in {{source 2006|4}} and {{source 2007|4}} this entity is obsolete.


In {{l4d|2}} and newer, the geometry is kept as a brush entity, and converted to a {{ent|func_simpleladder}} instead.
=== Since {{l4d|4}} ===
VBSP converts this to {{ent|func_simpleladder}} which has its keyvalues set based on [[%CompileTeam]] and which side of the brush has a ladder texture. The brush contents are '''NOT''' altered and depend on [[%CompileLadder]] flag. The <code>func_simpleladder</code> entity only exists in {{l4ds|2}}.


{{Note|This entity doesn't function in {{hl2ep1|2}} and newer, even if to added to base.fgd. Use {{Ent|Func_useableladder}} instead.<br>Func_ladder is still used in {{l4dseries|2}}, {{css|2}}, {{dods|2}}, {{Gmod|2}}, {{vtmb|2}}, and {{ship|2}}, but is not always necessary, depending upon whether the game uses {{ent|info_ladder}}/{{ent|func_simpleladder}}.}}
== Usage ==
{{Important|{{ent|func_simpleladder}} does not exist in {{csgobranch|1}} and {{strata|1}}, and as such, if a func_ladder is used, the brush will be deleted on spawn. Consult [[Creating Ladders (CSGO)]] for help.}}
* {{Left 4 Dead series|4}} - Use this. See [[L4D_Level_Design/Ladders]]. Can also use {{ent|func_brush}} if toggling it is neccessary but will be climbable from any side.  
{{warning| Func_ladder brushes are still world brushes, and will create [[visleaves]] unless using materials with {{cmd|%CompileDetail}} or {{cmd|%CompileClip}}. {{in|text=fixed in|{{tf2c}} {{ff}}}} {{tip|{{cmd|%CompileDetail}} parameter can safely be added to {{file|tools/toolsinvisbleladder|vmt}} without any negative consequences (the modified VMT does not need to be shared with the compiled map).<br>Alternatively, create a {{file|tools/toolsladder|vmt}} with {{cmd|%CompileClip}} instead of {{cmd|%CompileNoDraw}}+{{cmd|%CompilePassBullets}} (works in {{dods}}, but not {{css}}; must be tied to func_ladder).}}}}
* {{Half-Life 2 series|4}} - ({{portal|4}}{{confirm}}) Players or NPCs are unable to use ladder contents for climbing. Use {{ent|func_useableladder}} instead.
* {{Team Fortress 2|4}}, {{Portal 2|4}}, {{Alien Swarm}} - climbing not possible {{confirm}}. Needs workarounds [[Working_ladders#Brush-based_ladder_workaround]]
* '''anything else''' - use {{ent|func_detail}} (or {{ent|func_brush}} if toggling is wanted) with a <code>tools/toolsinvisbleladder</code> texture (or other that has <kbd>%CompileLadder</kbd>).


== Entity description ==
{{Note|Non {{hl2}} style climbing is prone to exploitation, as a player can travel up the ladder with two keys at once to travel faster up, and at the end of the ladder they will be flung.}}
A ladder. Players will be able to freely move along this brush, as if it was a ladder. If you are using a model prop for the visual representation of the ladder in the map, apply the '''toolsinvisibleladder''' material to the {{Ent|func_ladder}} brush.
 
This entity has no keyvalues, flags, inputs, or outputs.
 
{{Note|This entity is prone to exploitation, as a player can travel up the ladder with two keys at once to travel faster up, and at the end of the ladder they will be flung upwards to possibly reach high areas.}}
{{Internal entity note}}
 
== Keyvalues ==
{{KV Targetname null|hammer only=y}}


== See also ==
== See also ==
* [[Working Ladders]]
* [[Working Ladders]]

Revision as of 16:25, 1 May 2025

English (en)中文 (zh)Translate (Translate)

edit
Icon-NotInFGD.png
This entity is not in the FGD by default, except in Counter-Strike: SourceDay of Defeat: SourceLeft 4 DeadLeft 4 Dead 2Counter-Strike: Global Offensive.
See below for instructions on making it available.

func_ladder is an internal brush entity available in all Source Source games.

Differences

Before Left 4 Dead Left 4 Dead

When VBSP compiles the map, it converts func_ladder brushes into regular world brushes with added ladder contents, and an info_ladder entity is created with KVs indicating the bounding box of the ladder.

Because this type of info_ladder exists only in Source 2006 Source 2006 and Source 2007 Source 2007 this entity is obsolete.

Since Left 4 Dead Left 4 Dead

VBSP converts this to func_simpleladder which has its keyvalues set based on %CompileTeam and which side of the brush has a ladder texture. The brush contents are NOT altered and depend on %CompileLadder flag. The func_simpleladder entity only exists in Left 4 Dead seriesLeft 4 Dead series Left 4 Dead series.

Usage

Note.pngNote:Non Half-Life 2 style climbing is prone to exploitation, as a player can travel up the ladder with two keys at once to travel faster up, and at the end of the ladder they will be flung.

See also