Hud timer: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:hud_timer}}
{{tabs|hud_timer|vtmb = 1|source = 1|main = source}}
[[Image:Synergy_hud_timer_levelchange.jpg|thumb|right|300px|hud_timer example. '''TimerText''': "LEVEL CHANGE"]]  
[[File:Synergy_hud_timer_levelchange.jpg|thumb|right|300px|hud_timer example. '''TimerText''': "LEVEL CHANGE"]]  
{{Synergy}} '''hud_timer''' is a [[point entity]] available in [[Synergy]].
{{this is a|logical entity|name=hud_timer|game=Synergy}} It displays a countdown timer on every player's [[HUD]] and fires an output once reaching zero.
It displays a countdown timer on every player's [[HUD]] and fires an output once reaching zero.
{{tip|This is the same HUD element used during the "Waiting for Players" event before level transitions.}}
{{tip|This is the same HUD element used during the "Waiting for Players" event before level transitions.}}


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
<!--{{KV|TimerType|choices|Keep this set to 'Count Down Timer'(1) Other types not yet supported.}}-->
<!--{{KV|TimerType|choices|Keep this set to 'Count Down Timer'(1) Other types not yet supported.}}-->
{{KV|TimerText|string|Text to display when this timer is visible.}}
{{KV|TimerText|string|Text to display when this timer is visible.}}
{{tip|Try to keep the text under ~25 characters, otherwise it may protrude out of the HUD's frame. (ends will not be visible)}}
{{tip|Try to keep the text under ~25 characters, otherwise it may protrude out of the HUD's frame. (ends will not be visible)}}
{{KV Targetname}}


==Inputs==
==Inputs==
{{IO|Start|Start the timer with a specified duration of seconds.|param=int}}
{{I|Start|Start the timer with a specified duration of seconds.|param=int}}
{{IO|Stop|Stop the timer instantly, without triggering the OnTimer output.}}
{{I|Stop|Stop the timer instantly, without triggering the OnTimer output.}}
{{IO|Change|Update the timer time - value is added to current timer time; allows positive and negative values.|param=int}}
{{I|Change|Update the timer time - value is added to current timer time; allows positive and negative values.|param=int}}
{{I Targetname}}


==Outputs==
==Outputs==
{{IO|OnTimer|Fired when the timer reaches zero.}}
{{O|OnTimer|Fired when the timer reaches zero.}}
{{O Targetname}}


==See also==
==See also==
*[[Synergy_Entities|Synergy Entity List]]
*[[Synergy_Entities|Synergy Entity List]]


[[Category:Mod Entities]]
[[Category:Level Design]]
[[Category:Level Design]]

Latest revision as of 15:55, 23 May 2025

hud_timer example. TimerText: "LEVEL CHANGE"

hud_timer is a logical entity available in Synergy Synergy. It displays a countdown timer on every player's HUD and fires an output once reaching zero.

Tip.pngTip:This is the same HUD element used during the "Waiting for Players" event before level transitions.

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

TimerText ([todo internal name (i)]) <string>
Text to display when this timer is visible.
Tip.pngTip:Try to keep the text under ~25 characters, otherwise it may protrude out of the HUD's frame. (ends will not be visible)

Inputs

Start <integerRedirectInput/integer>
Start the timer with a specified duration of seconds.
Stop
Stop the timer instantly, without triggering the OnTimer output.
Change <integerRedirectInput/integer>
Update the timer time - value is added to current timer time; allows positive and negative values.

Outputs

OnTimer
Fired when the timer reaches zero.

See also