Func nav prerequisite: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Keyvalues: bug correction)
m (Setting bug notice hidetested=1 param on page where the bug might not need tested in param specified)
 
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{tf2 brush|func_nav_prerequisite}}
{{LanguageBar}}
{{this is a|brush entity|game=Team Fortress 2|name=func_nav_prerequisite}} It is also available in {{bms|4}}. It is a trigger volume that requires bots to do perform a task before they can move through it.


==Entity description==
{{note|<code>func_nav_prerequisite</code> triggers are only registered by the [[Navmesh]] on round start. To register them late, the following [[VScript]] snippet can be used to force a nav mesh update.
A trigger volume that requires bots to do perform a task before they can move through it.
<source lang=js>
RegisterScriptGameEventListener("round_start")
SendGlobalGameEvent("round_start", {})
</source>}}


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV Targetname}}
{{KV Parentname}}
{{KV|Task|intn=task|choices|What must be done to move through this volume}}
{{KV Origin}}
{{KV|Start Disabled|bool|Start disabled}}
{{KV|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.}}
{{KV|spawnflags|flags|spawn flags}}
{{KV|Filter Name|filterclass|Filter to use to see if activator triggers me. See filter_activator_name for more explanation.}}
{{KV|Task|choices|What must be done to move through this volume}}
:* 1 : Destroy Entity (Value = max range to attack from. -1 for no range restriction)
:* 1 : Destroy Entity (Value = max range to attack from. -1 for no range restriction)
{{bug|In {{tf2}}, this task does not function.}}
:{{bug|hidetested=1|In {{tf2}}, this task does not function. {{ModernConfirm|Also for {{bms|4}} ?}}}}
:* 2 : Move to Entity
:* 2 : Move to Entity
:* 3 : Wait (Value = seconds to wait)
:* 3 : Wait (Value = seconds to wait)
{{KV|Task Entity|target_destination|The subject entity of the Task}}
{{KV|Task Entity|intn=entity|target_destination|The subject entity of the Task.}}
{{KV|Task Value|float|A Task-specific value}}
{{KV|Task Value|intn=value|float|A Task-specific value.}}
{{KV TriggerOnce|base=1}}
 
==Flags==
{{Fl TriggerOnce}}


==Inputs==
==Inputs==
{{I Targetname}}
{{I Trigger|base=1}}
{{IO|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.}}
{{IO|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.}}
{{IO|ClearParent|Removes this entity from the the movement hierarchy, leaving it free to move independently.}}
{{I EnableDisable}}
{{IO|Toggle|Toggles this trigger between enabled and disabled states.}}
{{IO|DisableAndEndTouch|Disables this trigger and calls EndTouch on all currently-touching entities.}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O Trigger}}
{{IO|OnStartTouch|Fired when an entity starts touching this trigger. The touching entity must pass this trigger's filters to cause this output to fire.}}
{{IO|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.}}
{{IO|OnEndTouch|Fired when an entity stops touching this trigger. Only entities that passed this trigger's filters will cause this output to fire.}}
{{IO|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==
==See also==
*[[func_nav_prefer]] that influences bots to prefer this region by decreasing the pathfinding cost within it.
*{{ent|func_nav_prefer}}, which influences bots to prefer this region by decreasing the pathfinding cost within it.
*[[func_nav_avoid]] that influences bots to avoid this region by increasing the pathfinding cost within it.
*{{ent|func_nav_avoid}}, which influences bots to avoid this region by increasing the pathfinding cost within it.

Latest revision as of 07:16, 20 May 2025

English (en)Translate (Translate)

func_nav_prerequisite is a brush entity available in Team Fortress 2 Team Fortress 2. It is also available in Black Mesa Black Mesa. It is a trigger volume that requires bots to do perform a task before they can move through it.

Note.pngNote:func_nav_prerequisite triggers are only registered by the Navmesh on round start. To register them late, the following VScript snippet can be used to force a nav mesh update. 
RegisterScriptGameEventListener("round_start")
SendGlobalGameEvent("round_start", {})

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Task (task) <choices>
What must be done to move through this volume
  • 1 : Destroy Entity (Value = max range to attack from. -1 for no range restriction)
Icon-Bug.pngBug:In Team Fortress 2, this task does not function.
Confirm:Also for Black Mesa Black Mesa ?
  • 2 : Move to Entity
  • 3 : Wait (Value = seconds to wait)
Task Entity (entity) <targetname>
The subject entity of the Task.
Task Value (value) <float>
A Task-specific value.
BaseTrigger
Filter Name (filtername) <filter>
A filter entity to test potential activators against.
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Flags

BaseTrigger
Everything (not including physics debris) : [64]
Clients (Survivors, Special Infected, Tanks Left 4 Dead seriesLeft 4 Dead series) : [1]
Only clients in vehicles : [32]
Only clients *not* in vehicles : [512]
Disallow Bots (removed since Left 4 Dead) : [4096]
NPCs (Common Infected, Witches Left 4 Dead seriesLeft 4 Dead series) : [2]
Only player ally NPCs : [16]
Only NPCs in vehicles (respects player ally flag) : [2048]
Physics Objects (not including physics debris) : [8]
Physics debris (include also physics debris) : [1024]
Pushables (Passes entities with classname func_pushable) : [4] Obsolete
Deprecated.
Equivalent to using Everything + filter_activator_class that filters func_pushable.

Inputs

BaseTrigger
Toggle
Toggles this trigger between enabled and disabled states.
Enable
Enable trigger
Disable
Disable trigger
TouchTest  (in all games since Source 2007)
Triggers either the OnTouching or OnNotTouching outputs for whether anything is touching this entity.
Icon-Bug.pngBug:Sleeping prop_physics will never fire "OnTouching". Also applies to entities using prop_physics as base.  (tested in: Half-Life 2)
StartTouch  (in all games since Source 2007) !FGD
Behave as if the !caller entity had just entered the trigger volume. Accepts non-physical entities.
EndTouch  (in all games since Source 2007) !FGD
Behave as if !caller had just exited the trigger volume.
DisableAndEndTouch  (only in Source 2013 MultiplayerTeam Fortress 2 branch)
Disables this trigger and calls EndTouch on all currently-touching entities.

Outputs

BaseTrigger
OnStartTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger.
OnStartTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity starts touching this trigger, and no other entities are touching it. If there are any other entities touching the trigger when a new one begins to touch, only OnStartTouch will fire.
OnEndTouch
!activator = entity that caused this output
!caller = this entity
Fired when a valid entity stops touching this trigger.
Note.pngNote:Will also fire for entities touching it when trigger is disabled via Disable input
Warning.pngWarning:This includes entities which are deleted while inside the trigger. In this case !activator will be invalid.
Warning.pngWarning:OnEndTouch can fire before OnStartTouch under certain circumstances[How?] where both are fired on the same tick and each have the same delay.
Note.pngFix:Add a slight delay to OnEndTouch.
OnEndTouchAll
!activator = entity that caused this output
!caller = this entity
Fired when all valid entities stop touching this trigger.
OnTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if something is currently touching this trigger when TouchTest is fired.
OnNotTouching  (in all games since Source 2007)
!activator = !caller = this entity
Fired if nothing is currently touching this trigger when TouchTest is fired.

See also

  • func_nav_prefer, which influences bots to prefer this region by decreasing the pathfinding cost within it.
  • func_nav_avoid, which influences bots to avoid this region by increasing the pathfinding cost within it.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Func_nav_prerequisite&oldid=478951"