Difference between revisions of "Lua:AddHudTimerToTeam"

From Fortress Forever Wiki
Jump to navigationJump to search
m
m (2.42)
 
Line 1: Line 1:
 
{{Infobox manual/Header}}
 
{{Infobox manual/Header}}
 
{{Infobox_mapping}}
 
{{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===
 
===Usage===
<pre>AddHudTimerToTeam( team, huditemname, timername, x, y )
+
<pre>
 +
AddHudTimerToTeam(team, huditemname, timer, interval, x, y, align)
 +
 
 +
AddHudTimerToTeam( team, huditemname, timername, x, y )
 
AddHudTimerToTeam( team, huditemname, timername, x, y, align )
 
AddHudTimerToTeam( team, huditemname, timername, x, y, align )
 
AddHudTimerToTeam( team, huditemname, timername, x, y, alignx, aligny )</pre>
 
AddHudTimerToTeam( team, huditemname, timername, x, y, alignx, aligny )</pre>
Line 13: Line 16:
 
* team(CFFTeam) A reference to the team receiving the timer
 
* team(CFFTeam) A reference to the team receiving the timer
 
* huditemname(string) the name of this timer (so we can remove it later)
 
* huditemname(string) the name of this timer (so we can remove it later)
 +
 +
* timer(integer) the inital number of seconds on the timer
 +
* interval(integer) amount of time to add to the timer per second
 +
OR:
 
* timername(string) the name of a [[Lua:Timer]] object
 
* timername(string) the name of a [[Lua:Timer]] object
 +
 
* x(integer) horizontal position
 
* x(integer) horizontal position
 
* y(integer) vertical position
 
* y(integer) vertical position
Line 27: Line 35:
 
===Example===
 
===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==
 
==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]]
 
[[Category:HUD_Items]]
 
{{Infobox manual/Footer}}
 
{{Infobox manual/Footer}}

Latest revision as of 20:20, 25 June 2011


Mapping for FF
The Basics

Setting up Hammer
Getting Started With Lua
Releasing a map

FF-specific Entities

Lua location system

Map Templates
FF Lua Documentation

Entity Typing
Entity Collections

Commands
Callbacks

AddHudTimerToTeam

Puts a countdown timer on the screens of a specified team.

Usage

AddHudTimerToTeam(team, huditemname, timer, interval, x, y, align)

AddHudTimerToTeam( team, huditemname, timername, x, y )
AddHudTimerToTeam( team, huditemname, timername, x, y, align )
AddHudTimerToTeam( team, huditemname, timername, x, y, alignx, aligny )

Input

  • team(CFFTeam) A reference to the team receiving the timer
  • huditemname(string) the name of this timer (so we can remove it later)
  • timer(integer) the inital number of seconds on the timer
  • interval(integer) amount of time to add to the timer per second

OR:

  • 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

local team = GetTeam( Team.kRed )
AddHudTimerToTeam(team, "timer", 300, -1, 0, 70, 4)

Note

The timer is strictly a visual aid. To time actual game events, Use the Scheduling System