WoW:API GetArenaCurrency: Difference between revisions

Revision as of 03:41, 25 March 2007

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

Gets the amount of spendable arena points the player has

points = GetArenaCurrency()

points: Integer - Amount of arena points that the player has available and can spend

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
+Gets the amount of spendable arena points the player has
+ points = GetArenaCurrency()
-<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
-Gets amount of total spendable arena points
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
-{{Code/Begin}}
-arenapoints = GetArenaCurrency()
-{{Code/End}}
 == Parameters ==
+=== Returns ===
-<big>'''Arguments'''</big>
+:;points : Integer - Amount of arena points that the player has available and can spend
-<!-- List each argument, together with its type -->
-:;None known
-<big>'''Returns'''</big>
-<!-- List each return value, together with its type -->
-<!-- remove this line if it's just one value -->
-:;arenapoints: Number
-== Example ==
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
- local arenapoints = GetArenaCurrency()
-<big>'''Result'''</big>
-<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
- arenapoints = 36256
-==Details==
-<!-- Details not appropriate for the main description can go here.
-     REMOVE the section if you're just going to restate the intro line! -->