Path track: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Now with the correct numbers)
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=path_track}}
[[File:path_track.png|left|link=]]
{{base_point}}


== Entity description ==
{{base point|path_track}} It is used to build paths for other entities to follow. Each '''path_track''' is a node on the path, each holding the name of the next <code>path_track</code> in the path.
[[Image:{{PAGENAME}}.png|left]]An entity used to build paths for other entities to follow. Each '''path_track''' is a node on the path, each holding the name of the next <code>path_track</code> in the path.
 
{{clr}}


=== Automated track creation ===
=== Automated track creation ===
Line 11: Line 11:
=== Reversing over a path_track ===
=== Reversing over a path_track ===
{{bug|Normally, when given a ''StartBackward'' or ''Reverse'' input, a ''func_tracktrain'' will begin moving in reverse direction at its normal speed. However, due to coding glitches, if some of the path_tracks involved in the course have their "''New Train Speed''" property value set to '''0''', the train may stop moving, or may move in the wrong direction. This issue can be solved by setting the "New Train Speed" property in the involved tracktrains to a number other than zero.}}
{{bug|Normally, when given a ''StartBackward'' or ''Reverse'' input, a ''func_tracktrain'' will begin moving in reverse direction at its normal speed. However, due to coding glitches, if some of the path_tracks involved in the course have their "''New Train Speed''" property value set to '''0''', the train may stop moving, or may move in the wrong direction. This issue can be solved by setting the "New Train Speed" property in the involved tracktrains to a number other than zero.}}
* See also [[func_tracktrain]] - The entity that moves between these paths, and [[Trains]].


== Keyvalues ==
== Keyvalues ==
*{{KV Targetname}}
{{KV|Next Stop Target|target_destination|The next path_track in the path.}}
*{{KV Parentname}}
{{KV|Branch Path|target_destination|An alternative path_track to be the next node in the path. Useful for making branching paths. Use the <code>ToggleAlternatePath</code> / <code>EnableAlternatePath</code> inputs to make the alternative path active.}}
*{{KV Angles}}
{{KV|New Train Speed|float|When the train reaches this path_track, it will set its speed to this speed. This speed must be a positive value that is less than the train's max speed. A value of 0 will cause no change in the train's speed.}}
 
{{KV|Path radius|float|Used by NPCs who follow track paths (attack chopper/gunship). This tells them the maximum distance they're allowed to be from the path at this node.}}
*'''target'''
{{KV|Orientation Type|choices|The way that the path follower faces as it moves through this path track.}}
:<target_destination> The next <code>path_track</code> in the path.
:* 0 : No change
 
:* 1 : Face direction of motion
*'''altpath'''
:* 2 : Face this path_track's angles
:<target_destination> An alternative <code>path_track</code> to be the next node in the path. Useful for making branching paths. Use the ToggleAlternatePath / EnableAlternatePath inputs to make the alternative path active.
{{KV Targetname}}
 
{{KV Parentname}}
*'''speed'''
{{KV Angles}}
:<float> When the train reaches this path_track, it will set its speed to this speed. This speed must be a positive value that is less than the train's maximum speed. A value of 0 will cause no change in the train's speed.
: '''''Important Note''''' If this value is set to 0, the ''func_tracktrain'' may fail to reverse properly in a path involving this <code>path_track</code>. If the train stops in place or moves in the wrong direction, it is necessary to change this value to a nonzero number.
 
*'''radius'''
:<float> Used by NPCs who follow track paths (attack chopper/gunship). This tells them the maximum distance they're allowed to be from the path at this node.
 
*'''orientationtype'''
:<choices> The way that the path follower faces as it moves through this path track. ''Does not seem to work (with <code>[[func_tracktrain]]s</code> at least). (Always follows the direction of motion, rendering the ''angles'' keyvalue obsolete.)''
:{| class=standard-table
! Literal value || Description
|-
| 0 || No change
|-
| 1 || Face direction of motion
|-
| 2 || Face this <code>path_track</code>'s angles
|}


== Flags ==
== Flags ==
*1 : Disabled
* 1 : Disabled
*2 : Fire once
* 2 : Fire once
*4 : Branch Reverse
* 4 : Branch Reverse
*8 : Disable train
* 8 : Disable train
*16 : Teleport to THIS path track
* 16 : Teleport to THIS path track
*32 : TF2 payload uphill zone
* 32 : TF2 payload uphill zone
*64 : TF2 payload downhill zone
* 64 : TF2 payload downhill zone


== Inputs ==
== Inputs ==
*{{I Targetname}}
{{IO|ToggleAlternatePath|Cause the track to toggle to/from its alternate path.}}
*{{I Parentname}}
{{IO|EnableAlternatePath|Enable the alternate path of the track.}}
*'''ToggleAlternatePath'''
{{IO|DisableAlternatePath|Disable the alternate path of the track.}}
:Cause the track to toggle to/from its alternate path.
{{IO|TogglePath|Cause the track to toggle on/off}}
*'''EnableAlternatePath'''
{{IO|EnablePath|Enable the track.}}
:Enable the alternate path of the track.
{{IO|DisablePath|Disable the track.}}
*'''DisableAlternatePath'''
{{I Targetname}}
:Disable the alternate path of the track.
{{I Parentname}}
*'''TogglePath'''
:Cause the track to toggle on/off
*'''EnablePath'''
:Enable the track.
*'''DisablePath'''
:Disable the track.


== Outputs ==
== Outputs ==
*{{O Targetname}}
{{IO|OnPass|Fired when any entity following this path passes this path_track node.}}
*'''OnPass'''
{{IO|OnTeleport|Fired when any entity following this path teleports directly to this path_track node.}}
:Fired when any entity following this path passes this path_track node. {{activator|train}}
{{O Targetname}}
 
== See also ==
* [[func_tracktrain]] - The entity that moves between these paths, and [[Trains]].

Revision as of 07:32, 27 July 2011

Path track.png

Template:Base point It is used to build paths for other entities to follow. Each path_track is a node on the path, each holding the name of the next path_track in the path.

Automated track creation

Cloning (Shift-drag) this entity will activate a feature used to automatically and quickly create a track. This feature will alter both the Name keyvalue, and the Next Stop Target keyvalue, so that a track is created between the source and the clone. More specifically, Hammer will add a counter after the Name keyvalue of the clone, or increment this counter if it already exists, creating a unique name in a series. If a name is completely omitted, it will simply name the clone "path". If a Next Stop Target keyvalue has been specified, it will also alter this keyvalue of the source, to the name of the clone, resulting in a track being drawn between them.

Reversing over a path_track

Icon-Bug.pngBug:Normally, when given a StartBackward or Reverse input, a func_tracktrain will begin moving in reverse direction at its normal speed. However, due to coding glitches, if some of the path_tracks involved in the course have their "New Train Speed" property value set to 0, the train may stop moving, or may move in the wrong direction. This issue can be solved by setting the "New Train Speed" property in the involved tracktrains to a number other than zero.  [todo tested in ?]

Keyvalues

Next Stop Target ([todo internal name (i)]) <targetname>
The next path_track in the path.
Branch Path ([todo internal name (i)]) <targetname>
An alternative path_track to be the next node in the path. Useful for making branching paths. Use the ToggleAlternatePath / EnableAlternatePath inputs to make the alternative path active.
New Train Speed ([todo internal name (i)]) <float>
When the train reaches this path_track, it will set its speed to this speed. This speed must be a positive value that is less than the train's max speed. A value of 0 will cause no change in the train's speed.
Path radius ([todo internal name (i)]) <float>
Used by NPCs who follow track paths (attack chopper/gunship). This tells them the maximum distance they're allowed to be from the path at this node.
Orientation Type ([todo internal name (i)]) <choices>
The way that the path follower faces as it moves through this path track.
  • 0 : No change
  • 1 : Face direction of motion
  • 2 : Face this path_track's angles
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

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.
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
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

  • 1 : Disabled
  • 2 : Fire once
  • 4 : Branch Reverse
  • 8 : Disable train
  • 16 : Teleport to THIS path track
  • 32 : TF2 payload uphill zone
  • 64 : TF2 payload downhill zone

Inputs

ToggleAlternatePath
Cause the track to toggle to/from its alternate path.
EnableAlternatePath
Enable the alternate path of the track.
DisableAlternatePath
Disable the alternate path of the track.
TogglePath
Cause the track to toggle on/off
EnablePath
Enable the track.
DisablePath
Disable the track.


Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <stringRedirectInput/string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

OnPass
Fired when any entity following this path passes this path_track node.
OnTeleport
Fired when any entity following this path teleports directly to this path_track node.


See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Path_track&oldid=156069"