Func nav blocker

From Valve Developer Community
Revision as of 00:55, 30 September 2017 by TheRedMelon (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Available in the <Left 4 Dead><Left 4 Dead 2> Left 4 Dead series and <Counter-Strike: Global Offensive> Counter-Strike: Global Offensive. It is a brush entity that can block nav areas touching its AABB used to restrict NPCs from crossing over nav areas.

To do: Any other games?

To do: Use templates to display which games include this entity.

Note:The entity will NOT start to block automatically: it must first be activated with the BlockNav input.
Bug:  For <Left 4 Dead 2>, When you make the func_nav_blocker block the navigation squares touching it, you must send UnblockNav (Yes not intuitive) along with BlockNav if the func_nav_blocker resides on the same navigation square(s) as a prop_door_rotating or func_physbox and perhaps others entities. Failure to do so will create the console error "Area navsquare# already blocked by a different team id. May produce flow bugs" ( Which is does). The navigation square numbers can be seen in-game by pointing at the nav square with z_debug 1 and nav_edit 1.


Team(s) to block <choices>
Team(s) this entity should block
  • -1 : Everyone
  • 2 : <Left 4 Dead><Left 4 Dead 2> Survivors, <Counter-Strike: Global Offensive> Terrorists
  • 3 : <Left 4 Dead><Left 4 Dead 2> Infected, <Counter-Strike: Global Offensive> Counter-Terrorists
Affects Flow? <boolean>
Does this func_nav_blocker block flow in the level? Only func_nav_blockers with this enabled will cause flow recomputation on blocking/unblocking.


Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
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 <string> (New with Left 4 Dead 2)
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.


Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (probably with the Enable input).
Note:This KeyValue is not available in Smart Edit and must be added manually.

Warning: Enabled/disabled state does not block or unblock NAV areas. Use BlockNav/UnblockNav

Recheck Breakables <Boolean>
Appears to respond to any changes to breakables even though a BlockNav/UnblockNav input is fire anyway from the breakable prop anyway.
Note:This KeyValue is not available in Smart Edit and must be added manually.


BlockNav  <string>
Starts blocking nav areas.
Stops blocking nav areas.


Removes this entity and any entities parented to it from the world.
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.
AddOutput  <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode  <string> (New with Left 4 Dead 2)
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 <Left 4 Dead 2>, 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin  <coordinates> (New with Alien Swarm) !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> (New with Alien Swarm) !FGD
Set this entity's angles.


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

Warning: Enabled/disabled state does not block or unblock NAV areas.



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 the Left 4 Dead series)
This Output fires when the entity is killed and removed from the game.