WoW:API IsActiveBattlefieldArena: Difference between revisions

WoW:API IsActiveBattlefieldArena (source)

133 bytes added , 15 August 2023

m

Anonymous user

@@ Line 1: / Line 1: @@
-Returns information if you are currently in an arena game, it also returns if that arena game is "registered" (matched game)
+{{wowapi}} __NOTOC__
+Used for checking if the player is inside an arena or if it's a rated match
-  local isArena, isRegistered = IsActiveBattlefieldArena();
+  isArena, isRegistered = IsActiveBattlefieldArena();
+== Parameters ==
 === Returns ===
-:arg1 - arg2
-:;arg1 : Integer - 1 for true, nil for false
+:; isArena : Integer - 1 if the player is inside an arena, nil if they aren't
-:;arg2 : Integer - 1 for true, nil for false
+:; isRegistered : Integer - 1 if the player is playing a rated arena match, nil if they aren't
-----
-{{wowapi}}
+== Details ==
+: If you are in waiting room and/or countdown is going on, it will return false.