Difference between revisions of "Logic navigation"

From Valve Developer Community
Jump to: navigation, search
m (Keyvalues: oops now it is fixed)
m (fixed header)
 
Line 1: Line 1:
{{base point|logic_navigation}}  
+
{{base point|logic_navigation}} It is used to set navigation properties on other entities. Useful to make NPCs ignore physics props in their way that they can easily push.
 
 
==Entity description==
 
It is used to set navigation properties on other entities. Useful to make NPCs ignore physics props in their way that they can easily push.
 
  
 
{{Note|Due to some irregularities in the base [[FGD]], this entity's keys are best used with [[Hammer_Object_Properties_Dialog#SmartEdit|SmartEdit]] off.}}
 
{{Note|Due to some irregularities in the base [[FGD]], this entity's keys are best used with [[Hammer_Object_Properties_Dialog#SmartEdit|SmartEdit]] off.}}
  
== Keyvalues ==
+
==Keyvalues==
 
{{KV|Navigation Entity|target_destination|Name of the entity to set navigation properties on. }}
 
{{KV|Navigation Entity|target_destination|Name of the entity to set navigation properties on. }}
 
{{KV|Nav Property|choices|
 
{{KV|Nav Property|choices|
Line 12: Line 9:
 
{{KV Targetname}}
 
{{KV Targetname}}
  
== Flags ==
+
==Flags==
 
* 1 : Start On
 
* 1 : Start On
  
== Inputs ==
+
==Inputs==
 
{{IO|TurnOn|Turn on. The Navigation Entity will have its navigation properties set.}}
 
{{IO|TurnOn|Turn on. The Navigation Entity will have its navigation properties set.}}
 
{{IO|TurnOff|Turn off. The Navigation Entity will have its navigation properties returned to the default settings.}}
 
{{IO|TurnOff|Turn off. The Navigation Entity will have its navigation properties returned to the default settings.}}
Line 21: Line 18:
 
{{I Targetname}}
 
{{I Targetname}}
  
== Outputs ==
+
==Outputs==
 
{{O Targetname}}
 
{{O Targetname}}

Latest revision as of 02:54, 15 June 2018

logic_navigation is a point entity available in all Source games. It is used to set navigation properties on other entities. Useful to make NPCs ignore physics props in their way that they can easily push.

Note:Due to some irregularities in the base FGD, this entity's keys are best used with SmartEdit off.

Keyvalues

Navigation Entity <targetname>
Name of the entity to set navigation properties on.
Nav Property <choices>
  • Ignore : NPCs Ignore this when navigating (they'll bump into it)

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.

Flags

  • 1 : Start On

Inputs

TurnOn
Turn on. The Navigation Entity will have its navigation properties set.
TurnOff
Turn off. The Navigation Entity will have its navigation properties returned to the default settings.
Toggle
Toggle on/off.

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 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.

Outputs

Targetname:

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.