WoW API: GetPVPTimer

From AddOn Studio
Revision as of 03:47, 5 September 2009 by WoWWiki>Nafe (300000 changed to 301000 (API implementation must have changed))
Jump to navigation Jump to search

WoW API < GetPVPTimer

Returns the amount of time left on your PVP flag

local ms = GetPVPTimer()


Arguments

None


Returns

ms
Integer - Amount of time (in milliseconds) until your PVP flag wears off.


Details

If you are flagged for PVP permanently, the function returns 301000. If you are not flagged for PVP the function returns either 301000 or -1.


Example

Displays your current PVP status

local sec = math.floor(GetPVPTimer()/1000)
local msg = (not UnitIsPVP("player")) and "You are not flagged for PVP" or 
            (sec==301 and "You are perma-flagged for PVP" or 
             "Your PVP flag wears off in "..(sec>60 and math.floor(sec/60).." minutes " or "")..(sec%60).." seconds")
DEFAULT_CHAT_FRAME:AddMessage(msg)