Lua:AddHudTimerToTeam - Revision history

Crazycarl: 2.42

2011-06-26T04:20:37Z

2.42

Crazycarl at 04:10, 26 June 2011

2011-06-26T04:10:11Z

Crazycarl: 2.42

2011-06-26T04:09:31Z

2.42

New page

{{Infobox manual/Header}}
{{Infobox_mapping}}
==AddHudTimer==

Puts a countdown timer on a player's screen.

===Usage===
<pre>AddHudTimerToTeam( team, huditemname, timername, x, y )
AddHudTimerToTeam( team, huditemname, timername, x, y, align )
AddHudTimerToTeam( team, huditemname, timername, x, y, alignx, aligny )</pre>

===Input===
* team(CFFTeam) A reference to the team receiving the timer
* huditemname(string) the name of this timer (so we can remove it later)
* timername(string) the name of a [[Lua:Timer]] object
* x(integer) horizontal position
* y(integer) vertical position
* align(integer) x alignment options:
** 0: align to left
** 1: align to right
** 2: align to left of center
** 3: align to right of center

===Output===
Returns noting

===Example===

<pre>local player = CastToPlayer( player_entity )
AddHudTimer(player, "timer", 300, -1, 0, 70, 4)</pre>

==Note==
The timer is strictly a visual aid. To time actual game events, Use the [[:Category:Schedules|Scheduling System]] or [[Lua:Timers]]

[[Category:HUD_Items]]
{{Infobox manual/Footer}}

@@ Line 1: / Line 1: @@
 {{Infobox manual/Header}}
 {{Infobox_mapping}}
-==AddHudTimer==
+==AddHudTimerToTeam==
-Puts a countdown timer on a player's screen.
+Puts a countdown timer on the screens of a specified team.
 ===Usage===
-<pre>AddHudTimerToTeam( team, huditemname, timername, x, y )
+<pre>
 AddHudTimerToTeam( team, huditemname, timername, x, y, align )
 AddHudTimerToTeam( team, huditemname, timername, x, y, alignx, aligny )</pre>
@@ Line 13: / Line 16: @@
 * team(CFFTeam) A reference to the team receiving the timer
 * huditemname(string) the name of this timer (so we can remove it later)
 * timername(string) the name of a [[Lua:Timer]] object
 * x(integer) horizontal position
 * y(integer) vertical position
@@ Line 27: / Line 35: @@
 ===Example===
-<pre>local player = CastToPlayer( player_entity )
+<pre>local team = GetTeam( Team.kRed )
-AddHudTimer(player, "timer", 300, -1, 0, 70, 4)</pre>
+AddHudTimerToTeam(team, "timer", 300, -1, 0, 70, 4)</pre>
 ==Note==
-The timer is strictly a visual aid. To time actual game events, Use the [[:Category:Schedules|Scheduling System]] or [[Lua:Timer]]
+The timer is strictly a visual aid. To time actual game events, Use the [[:Category:Schedules|Scheduling System]]
 [[Category:HUD_Items]]
 {{Infobox manual/Footer}}