WoW:API GetPVPTimer: Difference between revisions

Latest revision as of 04:46, 15 August 2023

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.

ms = GetPVPTimer()

Returns

ms: Numbers - 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

The following snippet 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)

@@ Line 1: / Line 1: @@
-{{wowapi}} __NOTOC__
+{{wowapi}}
+Returns the amount of time left on your PVP flag.
+ ms = GetPVPTimer()
-Returns the amount of time left on your PVP flag
+== Returns ==
- local ms = GetPVPTimer()
+;ms : Numbers - 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.
-=== Arguments ===
+== Example ==
-None
+The following snippet displays your current PVP status:
-=== 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
+              (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)