Team round timer: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Updated with data from tf-abs.fgd)
Line 1: Line 1:
{{wrongtitle|title=team_round_timer}}
{{tf2 point|team_round_timer}}
{{Tf2 point}}


== Entity description ==
==Entity description==
Round Timer. Timer starts paused by default.
Round Timer. Timer starts paused by default.


== Keyvalues ==
==Keyvalues==
* {{KV Targetname}}
{{KV Targetname}}
* {{KV EnableDisable}}
{{KV EnableDisable}}
* '''timer_length'''
{{KV|Timer length (in seconds)|integer|Initial timer length.}}
: <integer> Initial timer length. (in seconds)
{{KV|Max timer length (in seconds)|integer|Maximum timer length (0 {{=}} no max). This value is used to ensure the timer never goes above this value when SetTime and AddTime are used.}}
* '''max_length'''
{{KV|Start paused|boolean|Should the timer start paused? (will need to send a Resume input to start the timer if this is set).}}
: <integer> Maximum timer length (0 = no max). This value is used to ensure the timer never goes above this value when SetTime and AddTime are used. (in seconds)
{{KV|Setup timer length (in seconds)|integer|Length of setup time before the round begins and the timer starts to countdown the normal time. (0 {{=}} no setup time)  Setup time is run at the beginning of every round before the normal time begins.}}
* '''start_paused'''
{{KV|Reset time on round restart|boolean|Reset the timer time after a round restart.  This is not the setup time, but the normal round time.}}
: {{boolean}} Should the timer start paused? (will need to send a Resume input to start the timer if this is set).
{{KV|Use countdown sounds|boolean|Let the timer automatically count down the end of a round.}}
* '''setup_length'''
{{KV|Show timer in the HUD|boolean|Note: You can only show one timer in the HUD at a time.}}
: <integer> Length of setup time before the round begins and the timer starts to countdown the normal time. (0 = no setup time)  Setup time is run at the beginning of every round before the normal time begins. (in seconds)
{{KV|Count Direction|choices|Use this to reverse the timer and have it count from 0 up to the timer length. Sounds and outputs still fire like normal. For example, on a count-up timer with a length of 90 seconds, when it reaches 60 the announcer will say '30 seconds remanining', however, the On30SecRemaining output will fire when the visual timer reaches 61.}}
* '''reset_time'''
:* 0 : Up
: {{boolean}} Reset the timer time after a round restart.  This is not the setup time, but the normal round time.
:* 1 : Down
* '''auto_countdown'''
: {{boolean}} Let the timer automatically count down the end of a round.
* '''show_in_hud'''
: {{boolean}} Note: You can only show one timer in the HUD at a time.


== Inputs ==
==Inputs==
* {{I Targetname}}
{{I Targetname}}
* {{I EnableDisable}}
{{I EnableDisable}}
* '''Pause'''
{{IO|Pause|Pause the timer.}}
: Pause the timer.
{{IO|Resume|Resume the timer.}}
* '''Resume'''
{{IO|SetTime|Set the timer to this value (in seconds).|param=integer}}
: Resume the timer.
{{IO|AddTime|Add time to the timer (in seconds). Added time cannot excede the max timer length.|param=integer}}
* '''SetTime'''
{{IO|AddTeamTime|Input takes a string (space delimited) with the team number and the time to be added (in seconds) because of the team (2 for red, 3 for blue, and 0 for no team...but you could just use AddTime for that). Added time cannot excede the max timer length. Example: 2 600 (adds 10 minutes because of team red)|param=string}}
: <integer> Set the timer to this value (in seconds).
{{IO|Restart|Restart the timer.}}
* '''AddTime'''
{{IO|ShowInHUD|Show this timer in the HUD (0 no, 1 yes).|param=bool}}
: <integer> Add time to the timer (in seconds). Added time cannot excede the max timer length.
{{IO|SetMaxTime|Set the max timer length to this value (in seconds). The timer's time will never excede this value.|param=integer}}
* '''AddTeamTime'''
{{IO|AutoCountdown|Turn off/on the auto countdown feature (0 no, 1 yes).|param=bool}}
: <string> Input takes a string (space delimited) with the team number and the time to be added (in seconds) because of the team (2 for red, 3 for blue, and 0 for no team...but you could just use AddTime for that). Added time cannot excede the max timer length. Example: 2 600 (adds 10 minutes because of team red)
{{IO|SetSetupTime|Set the setup time length to this value (in seconds).|param=integer}}
* '''Restart'''
: Restart the timer.
* '''ShowInHUD'''
: <integer> Show this timer in the HUD (0 no, 1 yes).
* '''SetMaxTime'''
: <integer> Set the max timer length to this value (in seconds). The timer's time will never excede this value.
* '''AutoCountdown'''
: <integer> Turn off/on the auto countdown feature (0 no, 1 yes).
* '''SetSetupTime'''
: <integer> Set the setup time length to this value (in seconds).


== Outputs ==
==Outputs==
* {{O Targetname}}
{{O Targetname}}
* '''On5MinRemain'''
{{IO|On5MinRemain|Sent when 5 minutes remain.}}
: Sent when 5 minutes remain.
{{IO|On4MinRemain|Sent when 4 minutes remain.}}
* '''On4MinRemain'''
{{IO|On3MinRemain|Sent when 3 minutes remain.}}
: Sent when 4 minutes remain.
{{IO|On2MinRemain|Sent when 2 minutes remain.}}
* '''On3MinRemain'''
{{IO|On1MinRemain|Sent when 1 minutes remain.}}
: Sent when 3 minutes remain.
{{IO|On30SecRemain|Sent when 30 seconds remain.}}
* '''On2MinRemain'''
{{IO|On10SecRemain|Sent when 10 seconds remain.}}
: Sent when 2 minutes remain.
{{IO|On5SecRemain|Sent when 5 seconds remain.}}
* '''On1MinRemain'''
{{IO|On4SecRemain|Sent when 4 seconds remain.}}
: Sent when 1 minute remains.
{{IO|On3SecRemain|Sent when 3 seconds remain.}}
* '''On30SecRemain'''
{{IO|On2SecRemain|Sent when 2 seconds remain.}}
: Sent when 30 seconds remain.
{{IO|On1SecRemain|Sent when 1 second remains.}}
* '''On10SecRemain'''
{{IO|OnRoundStart|Sent when the round starts.}}
: Sent when 10 seconds remain.
{{IO|OnFinished|Sent when the timer is finished.}}
* '''On5SecRemain'''
{{IO|OnSetupStart|Sent when the setup time begins.}}
: Sent when 5 seconds remain.
{{IO|OnSetupFinished|Sent when the setup time is finished.}}
* '''On4SecRemain'''
: Sent when 4 seconds remain.
* '''On3SecRemain'''
: Sent when 3 seconds remain.
* '''On2SecRemain'''
: Sent when 2 seconds remain.
* '''On1SecRemain'''
: Sent when 1 second remains.
* '''OnRoundStart'''
: Sent when the round starts.
* '''OnFinished'''
: Sent when the timer is finished.
* '''OnSetupStart'''
: Sent when the setup time begins.
* '''OnSetupFinished'''
: Sent when the setup time is finished.
 
[[Category:Team Fortress 2 Entities]]

Revision as of 22:16, 9 May 2011

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

Entity description

Round Timer. Timer starts paused by default.

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).
Timer length (in seconds) ([todo internal name (i)]) <integer>
Initial timer length.
Max timer length (in seconds) ([todo internal name (i)]) <integer>
Maximum timer length (0 = no max). This value is used to ensure the timer never goes above this value when SetTime and AddTime are used.
Start paused ([todo internal name (i)]) <boolean>
Should the timer start paused? (will need to send a Resume input to start the timer if this is set).
Setup timer length (in seconds) ([todo internal name (i)]) <integer>
Length of setup time before the round begins and the timer starts to countdown the normal time. (0 = no setup time) Setup time is run at the beginning of every round before the normal time begins.
Reset time on round restart ([todo internal name (i)]) <boolean>
Reset the timer time after a round restart. This is not the setup time, but the normal round time.
Use countdown sounds ([todo internal name (i)]) <boolean>
Let the timer automatically count down the end of a round.
Show timer in the HUD ([todo internal name (i)]) <boolean>
Note: You can only show one timer in the HUD at a time.
Count Direction ([todo internal name (i)]) <choices>
Use this to reverse the timer and have it count from 0 up to the timer length. Sounds and outputs still fire like normal. For example, on a count-up timer with a length of 90 seconds, when it reaches 60 the announcer will say '30 seconds remanining', however, the On30SecRemaining output will fire when the visual timer reaches 61.
  • 0 : Up
  • 1 : Down

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Pause
Pause the timer.
Resume
Resume the timer.
SetTime <integerRedirectInput/integer>
Set the timer to this value (in seconds).
AddTime <integerRedirectInput/integer>
Add time to the timer (in seconds). Added time cannot excede the max timer length.
AddTeamTime <stringRedirectInput/string>
Input takes a string (space delimited) with the team number and the time to be added (in seconds) because of the team (2 for red, 3 for blue, and 0 for no team...but you could just use AddTime for that). Added time cannot excede the max timer length. Example: 2 600 (adds 10 minutes because of team red)
Restart
Restart the timer.
ShowInHUD <booleanRedirectInput/boolean>
Show this timer in the HUD (0 no, 1 yes).
SetMaxTime <integerRedirectInput/integer>
Set the max timer length to this value (in seconds). The timer's time will never excede this value.
AutoCountdown <booleanRedirectInput/boolean>
Turn off/on the auto countdown feature (0 no, 1 yes).
SetSetupTime <integerRedirectInput/integer>
Set the setup time length to this value (in seconds).

Outputs

On5MinRemain
Sent when 5 minutes remain.
On4MinRemain
Sent when 4 minutes remain.
On3MinRemain
Sent when 3 minutes remain.
On2MinRemain
Sent when 2 minutes remain.
On1MinRemain
Sent when 1 minutes remain.
On30SecRemain
Sent when 30 seconds remain.
On10SecRemain
Sent when 10 seconds remain.
On5SecRemain
Sent when 5 seconds remain.
On4SecRemain
Sent when 4 seconds remain.
On3SecRemain
Sent when 3 seconds remain.
On2SecRemain
Sent when 2 seconds remain.
On1SecRemain
Sent when 1 second remains.
OnRoundStart
Sent when the round starts.
OnFinished
Sent when the timer is finished.
OnSetupStart
Sent when the setup time begins.
OnSetupFinished
Sent when the setup time is finished.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Team_round_timer&oldid=149769"