WoW API: GetPVPTimer

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← 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 300000. If you are not flagged for PVP the function returns either 300000 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==300 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)