func_nav_prerequisite
From Valve Developer Community
func_nav_prerequisite is a brush entity available in Team Fortress 2.
Entity description
A trigger volume that requires bots to do perform a task before they can move through it.
Keyvalues
Targetname:
- 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.
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.
Origin:
- Origin (X Y Z)
<origin>
- The position of this entity's center in the world. Rotating entities typically rotate around their origin.
- Start Disabled
<boolean>
- Start disabled
- Global Entity Name
<string>
- Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
- spawnflags
<flags>
- spawn flags
- Filter Name
<filter>
- Filter to use to see if activator triggers me. See filter_activator_name for more explanation.
- Task
<choices>
- What must be done to move through this volume
- Task Entity
<targetname>
- The subject entity of the Task
- Task Value
<float>
- A Task-specific value
Inputs
Targetname:
-
Kill
- Removes this entity and any entities parented to it from the world.
-
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
. -
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
toFireUser4
- 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
, 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.
-
SetParentAttachment <string>
- Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
-
SetParentAttachmentMaintainOffset <string>
- Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.
-
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
EnableDisable:
Enable
Disable
- Enable/disable this entity from performing its task. It might also disappear from view.
-
Toggle
- Toggles this trigger between enabled and disabled states.
-
DisableAndEndTouch
- Disables this trigger and calls EndTouch on all currently-touching entities.
Outputs
Targetname:
-
OnUser1
toOnUser4
- These Outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
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.
-
OnStartTouch
- Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire.
-
OnStartTouchAll
- Fired when an entity starts touching this trigger, and no other entities are touching it. Only entities that passed this trigger's filters are considered.
-
OnEndTouch
- Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire.
-
OnEndTouchAll
- Fires when an entity stops touching this trigger, and no other entities are touching it. Only entities that passed this trigger's filters are considered.
See Also
- func_nav_prefer that influences bots to prefer this region by decreasing the pathfinding cost within it.