Team train watcher: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Substituted IO templates)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{wrongtitle|title=team_train_watcher}}
{{this is a|point entity|game=Team Fortress 2|name=team_train_watcher}}
{{Tf2 point}}
{{edictcount-box|1}}
{{stub}}
==Entity description==
Entity that tracks the train progress through train escort maps. Adding this entity to a map makes Team Fortress 2 classify the map as a train escort (Payload) map.


== Entity description ==
For a Payload Race map, you also need a [[Tf logic multiple escort|tf_logic_multiple_escort]] entity.
This entity is what shows the HUD for Payload maps.


== Keyvalues ==
==Keyvalues==
* {{KV Targetname}}
{{KV Targetname}}
* {{KV EnableDisable}}
{{KV EnableDisable}}
* '''goal_node'''
{{KV TFTeam}}
: <target_destination> Name of the last [[path_track]] on the train's path.
{{KV|Allow the train to recede?|boolean}}
*'''hud_min_speed_level_1'''
{{KV|Handle Train Movement|boolean|If Yes, the watcher will handle three-speed forward movement, receding, and roll forward/back zones. Slow areas (such as for uphill) will need to be done manually by sending the watcher a SetSpeedForwardModifier input.|nofgd=1}}
: <integer>
{{KV|uphill_speed_modifier|nofgd=1}}
*'''hud_min_speed_level_2'''
{{KV|speed_forward_modifier|nofgd=1}}
: <integer>
{{KV|env_spark_name|target_destination|The name of the env_spark for the train.|nofgd=1}}
*'''hud_min_speed_level_3'''
{{KV|Default Speed Modifier|float|0 to 1 scaling of the train's max speed. Can be adjusted with the SetSpeedForwardModifier input. Only functions with Handle Train Movement enabled.}}
: <integer>
{{KV|Min Speed for Speed Level 1|float}}
*'''linked_cp_1'''
{{KV|Min Speed for Speed Level 2|float}}
: <target> Name of the first [[team_control_point]]. This will put the circle on the HUD representing which team controls the point.
{{KV|Min Speed for Speed Level 3|float}}
*'''linked_cp_2'''
: <target> Name of the second team_control_point.
*'''linked_cp_3'''
: <target> Name of the third team_control_point.
*'''linked_pathtrack_1'''
: <target> Name of the path_track located at the first control point. This will tell the HUD where to put said circle onto the "track"
*'''linked_pathtrack_2'''
: <target> Name of the path_track located at the second control point.
*'''linked_pathtrack_3'''
: <target> Name of the path_track located at the third control point.
*'''start_node'''
: <target> Name of the path_track the train starts at.
*'''train'''
: <target> Name of the [[func_tracktrain]] entity.


== Inputs ==
==Inputs==
*'''SetNumTrainCappers'''
{{I TFTeam}}
: <integer> Basically sets how many people are standing next to the train.
{{I Targetname}}
*{{I EnableDisable}}
{{I EnableDisable}}
*{{I Targetname}}
{{I|SetNumTrainCappers|Set Number of players capping the train.|param=integer}}
{{I|SetSpeedForwardModifier|param=float}}
{{I|OnStartOvertime|Sets the cart to 5 seconds until recede.}}


== Outputs ==
==Outputs==
*'''OnTrainStartRecede'''
{{O Targetname}}
{{O|OnTrainStartRecede|Sent when the train should start receding.}}


*{{O Targetname}}
==See also==
 
[[TF2/Creating_a_Payload_Map|Creating a payload map for Team Fortress 2]]
[[Category:Team Fortress 2 Entities]]

Latest revision as of 23:03, 20 April 2025

team_train_watcher is a point entity available in Team Fortress 2 Team Fortress 2.

This entity consumes 1 edict slots at runtime.

Entity description

Entity that tracks the train progress through train escort maps. Adding this entity to a map makes Team Fortress 2 classify the map as a train escort (Payload) map.

For a Payload Race map, you also need a tf_logic_multiple_escort entity.

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

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).
TeamNum:
Initial Team (TeamNum) <choices>
Which Team the entity belongs / is assigned to on spawn
  • 0: None
  • 1: Spectator/Halloween Souls Team Fortress 2
  • 2: RED Team Fortress 2
  • 3: BLU/Robots Team Fortress 2
  • 5: Halloween Bosses (only in Team Fortress 2) !FGD


Allow the train to recede? ([todo internal name (i)]) <boolean>
Handle Train Movement ([todo internal name (i)]) <boolean> !FGD
If Yes, the watcher will handle three-speed forward movement, receding, and roll forward/back zones. Slow areas (such as for uphill) will need to be done manually by sending the watcher a SetSpeedForwardModifier input.
uphill_speed_modifier ([todo internal name (i)])  !FGD
speed_forward_modifier ([todo internal name (i)])  !FGD
env_spark_name ([todo internal name (i)]) <targetname> !FGD
The name of the env_spark for the train.
Default Speed Modifier ([todo internal name (i)]) <float>
0 to 1 scaling of the train's max speed. Can be adjusted with the SetSpeedForwardModifier input. Only functions with Handle Train Movement enabled.
Min Speed for Speed Level 1 ([todo internal name (i)]) <float>
Min Speed for Speed Level 2 ([todo internal name (i)]) <float>
Min Speed for Speed Level 3 ([todo internal name (i)]) <float>

Inputs

SetTeam <integerRedirectInput/integer>
Changes the entity's team.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
SetNumTrainCappers <integerRedirectInput/integer>
Set Number of players capping the train.
SetSpeedForwardModifier <floatRedirectInput/float>
OnStartOvertime
Sets the cart to 5 seconds until recede.

Outputs

OnTrainStartRecede
Sent when the train should start receding.

See also

Creating a payload map for Team Fortress 2

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