Team train watcher: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Updated with data from tf-abs.fgd)
m (Substituted IO templates)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{tf2 point|team_train_watcher}}
{{this is a|point entity|game=Team Fortress 2|name=team_train_watcher}}
{{edictcount-box|1}}
==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.
Entity that tracks the train progress through train escort maps.


==Keyvalues==
==Keyvalues==
Line 9: Line 11:
{{KV TFTeam}}
{{KV TFTeam}}
{{KV|Allow the train to recede?|boolean}}
{{KV|Allow the train to recede?|boolean}}
{{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.}}
{{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}}
{{KV|uphill_speed_modifier|nofgd=1}}
{{KV|speed_forward_modifier|nofgd=1}}
{{KV|env_spark_name|target_destination|The name of the env_spark for the train.|nofgd=1}}
{{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.}}
{{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.}}
{{KV|Min Speed for Speed Level 1|float}}
{{KV|Min Speed for Speed Level 1|float}}
Line 15: Line 20:
{{KV|Min Speed for Speed Level 3|float}}
{{KV|Min Speed for Speed Level 3|float}}


==Flags==
==Inputs==
{{I TFTeam}}
{{I TFTeam}}
==Inputs==
{{I Targetname}}
{{I Targetname}}
{{I EnableDisable}}
{{I EnableDisable}}
{{IO|SetNumTrainCappers|Set Number of players capping the train.|param=integer}}
{{I|SetNumTrainCappers|Set Number of players capping the train.|param=integer}}
{{IO|SetSpeedForwardModifier|param=float}}
{{I|SetSpeedForwardModifier|param=float}}
{{IO|OnStartOvertime|Sets the cart to 5 seconds until recede.}}
{{I|OnStartOvertime|Sets the cart to 5 seconds until recede.}}


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


==See Also==
==See also==
[[TF2/Creating_a_Payload_Map|Creating a payload map for Team Fortress 2]]
[[TF2/Creating_a_Payload_Map|Creating a payload map for Team Fortress 2]]

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"