Lua:AddHudTimer

From Fortress Forever Wiki
Revision as of 21:04, 25 June 2011 by Crazycarl (talk | contribs) (2.42)
Jump to navigationJump to search


AddHudTimer

Puts a countdown timer on a player's screen.

Usage

AddHudTimer( player, huditemname, timername, x, y )
AddHudTimer( player, huditemname, timername, x, y, align )
AddHudTimer( player, huditemname, timername, x, y, alignx, aligny )

Input

  • player(CFFPlayer) A reference to the player receiving the timer
  • hudID(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?
  • 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 player = CastToPlayer( player_entity )
AddHudTimer(player, "timer", 300, -1, 0, 70, 4)

Note

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