Template:KV NavBlocker/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "<!--{{otherlang2 |title= }}--> {{Documentation subpage}} <!-- Please place categories where indicated at the bottom of this page.) --> A template that generates every keyvalue...")
 
m (→‎top: clean up, replaced: {{Documentation subpage → {{Doc/subpage)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
|title=
|title=
}}-->
}}-->
{{Documentation subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
A template that generates every keyvalue relevant to nav blockers. Meant for [[func_nav_blocker]] and [[script_nav_blocker]].
A template that generates every keyvalue relevant to nav blockers. Meant for [[func_nav_blocker]] and [[script_nav_blocker]].
Line 29: Line 29:
<pre>{{KV NavBlocker}}</pre>
<pre>{{KV NavBlocker}}</pre>
{{ExpandBox|{{KV NavBlocker}}|will:}}
{{ExpandBox|{{KV NavBlocker}}|will:}}
==See Also==
==See also==
* {{tl|I NavBlocker}}
* {{tl|I NavBlocker}}



Latest revision as of 02:16, 12 January 2024

Edit-copy.png
This is a documentation subpage for Template:KV NavBlocker.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

A template that generates every keyvalue relevant to nav blockers. Meant for func_nav_blocker and script_nav_blocker.

Usage

These must be used in a specific syntax! - ALL parameters must be given a value of 1, like:l4d2=1. Only one game parameter can be used at once.

{{KV NavBlock|l4d2=1}}

Parameters

If you leave the parameter field empty (using no arguments), the template will automatically fallback to displaying information from ALL games.

All parameters for this template:

  • l4d2- Set template KVs specific to Left 4 Dead 2

Refer to the Examples section for samples.

Examples

Show info specific to a game Left 4 Dead 2

This makes information specific to Left 4 Dead 2 be displayed.

{{KV TeamNum|l4d2=1}}
will: 
Team(s) to block (teamToBlock) <choices>
Team this entity should block.
  • -1 : Everyone
  • 2 : Survivors
  • 3 : Infected
Affects Flow? (affectsFlow) <boolean>
Does this Nav Blocker block flow in the level? Only Nav Blocker with this enabled will cause flow recomputation on blocking/unblocking. :
Icon-Important.pngImportant:Don't block the only path to the level's goal or flow won't be computed properly

Show information for all games

Shows every game information for this key that this template can display.

{{KV NavBlocker}}
will: 
Team(s) to block (teamToBlock) <choices>
Team this entity should block.
  • -1 : Everyone
    Warning.pngWarning:Team Fortress 2 for everyone either edit FGD and use value -2 or turn off smart edit and set that, -1 is not valid and the nav blocker will not work
  • 2 : Red Team Fortress 2, Survivors Left 4 Dead seriesLeft 4 Dead series, Terrorists Counter-Strike: Source Counter-Strike: Global Offensive
  • 3 : Blue Team Fortress 2, Infected Left 4 Dead seriesLeft 4 Dead series, Counter-Terrorists Counter-Strike: Source Counter-Strike: Global Offensive
Note.pngNote:Counter-Strike: Global Offensive teamToBlock non-functional, always blocks either for both teams or for no team.
Affects Flow? (affectsFlow) <boolean> (only in Left 4 Dead 2)
Does this Nav Blocker block flow in the level? Only Nav Blocker with this enabled will cause flow recomputation on blocking/unblocking.
Icon-Important.pngImportant:When this is true don't block the only path to the level's goal with it or the flow won't be computed properly

See also

  • {{I NavBlocker}}