Difference between revisions of "Info node climb"

From Valve Developer Community
Jump to: navigation, search
 
m (Added an image of the node)
 
(34 intermediate revisions by 14 users not shown)
Line 1: Line 1:
info_node_climb
+
[[File: info_node_climb.png | right | 300px]]
  
A climb-node for AI navigation. Only usable by NPCs that can climb.
+
{{base_point|info_node_climb}}
 +
__TOC__
 +
{{clr}}
  
KEYS
+
==Entity description==
 +
A [[nodegraph]] and [[hint node]] entity, used only by [[:Category:Climbing NPCs|Climbing NPCs]].
  
Name targetname <target_source> The name that other entities refer to this entity by.
+
== Keyvalues ==
 +
{{KV Targetname}}
 +
{{KV Angles}}
 +
{{KV HintNode}}
  
Pitch Yaw Roll (Y Z X) angles <angle> This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
+
== Flags ==
 +
{{Fl HintNode}}
  
Node ID nodeid <integer>
+
== Inputs ==
 +
{{I Targetname}}
 +
{{I HintNode}}
  
Hint hinttype <choices>
+
== Outputs ==
 +
{{O Targetname}}
  
Hint Activity hintactivity <string> Activity associated with this hint node. Various parts of the NPC AI play this activity at times. i.e. Actbusy nodes will play this activity when an NPC acts busy on the node.
+
[[Category:AI]]
 
 
Node FOV nodeFOV <choices> Imagine this node requires that an NPC be in the node's field of view in order to use this hint.
 
 
 
Start Hint Disabled StartHintDisabled <choices>
 
 
 
Hint Group Group <string> If specified, gives the hint a specific group name.  Useful for hint nodes that need to be logically grouped together. NPCs may also refuse to use hint nodes that don't match their hint group.
 
 
 
Target node TargetNode <node_dest> The node ID of an associated target node, if any.
 
 
 
Ignore Facing IgnoreFacing <choices> Don't pay attention to the facing of the node. May not apply to a given hint type.
 
 
 
Minimum State MinimumState <choices> Require an NPC have a minimum state to use the hint.
 
 
 
Maximum State MaximumState <choices> Require an NPC have a maximum state to use the hint.
 
 
 
 
 
INPUTS
 
 
 
Kill Removes this entity from the world.
 
 
 
KillHierarchy Removes this entity and all its children from the world.
 
 
 
AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
 
 
 
FireUser1 Causes this entity's OnUser1 output to be fired.
 
 
 
FireUser2 Causes this entity's OnUser2 output to be fired.
 
 
 
FireUser3 Causes this entity's OnUser3 output to be fired.
 
 
 
FireUser4 Causes this entity's OnUser4 output to be fired.
 
 
 
EnableHint Enable hint.
 
 
 
DisableHint Disable hint.
 
 
 
 
 
OUTPUTS
 
 
 
OnUser1 Fired in response to FireUser1 input.
 
 
 
OnUser2 Fired in response to FireUser2 input.
 
 
 
OnUser3 Fired in response to FireUser3 input.
 
 
 
OnUser4 Fired in response to FireUser4 input.
 

Latest revision as of 18:14, 18 June 2019

Info node climb.png
info_node_climb is a point entity available in all Source games.

Entity description

A nodegraph and hint node entity, used only by Climbing NPCs.

Keyvalues

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since <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 (thinkfunction) <string> (in all games since <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.

Angles:

Pitch Yaw Roll (Y Z X) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

HintNode:

Hint <choices>
Hint type

Hint Activity <string>
Activity associated with this hint node. Various parts of the NPC AI play this activity at times. i.e. Actbusy nodes will play this activity when an NPC acts busy on the node.
Node FOV <choices>
Imagine this node requires that an NPC be in the node's field of view in order to use this hint.
  • 45 : 45 Degrees
  • 90 : 90 Degrees
  • 180 : 180 Degrees
  • 360 : 360 Degrees
Start Hint Disabled <boolean>
Spawn the hint disabled.
Hint Group <string>
If specified, gives the hint a specific group name. Useful for hint nodes that need to be logically grouped together. NPCs may also refuse to use hint nodes that don't match their hint group.
Target node <node_dest>
The node ID of an associated target node, if any.
Ignore Facing <choices>
Don't pay attention to the facing of the node. May not apply to a given hint type.
  • 0 : No
  • 1 : Yes
  • 2 : Default
Minimum State <choices>
Require an NPC have a minimum state to use the hint.
  • 1 : Idle
  • 2 : Alert
  • 3 : Combat
Maximum State <choices>
Require an NPC have a maximum state to use the hint.
  • 1 : Idle
  • 2 : Alert
  • 3 : Combat
Node ID <integer>
Read-only internal Hammer value.

Flags

HintNode:

  • 65536 : Allow jump up

Inputs

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O 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 depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <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> (in all games since <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> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <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> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.

HintNode:

EnableHint
Enable hint.
DisableHint
Disable hint.

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