WoW:API GetHonorCurrency: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
(Changed formatting and information, added Details.)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
 
Gets the amount of spendable honor 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 honor points
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
{{Code/Begin}}
honorpoints = GetHonorCurrency()
{{Code/End}}
 


== Parameters ==
== Parameters ==
=== Returns ===
:;points : Integer - Amount of honor points that the player has available and can spend


<big>'''Arguments'''</big>
----
<!-- List each argument, together with its type -->
=== Details ===
:;None known
Amount of honor points the player currently has to spend, HONOR_CURRENCY_UPDATE is fired when they are spent or when honor is calculated for the day.
 
 
<big>'''Returns'''</big>
<!-- List each return value, together with its type -->
<!-- remove this line if it's just one value -->
 
:;honorpoints: Number
 
 
== Example ==
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
local honorpoints = GetHonorCurrency()
 
<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. -->
honorpoints = 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! -->

Revision as of 03:44, 25 March 2007

WoW API < GetHonorCurrency

Gets the amount of spendable honor points the player has

points = GetArenaCurrency()

Parameters

Returns

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

Details

Amount of honor points the player currently has to spend, HONOR_CURRENCY_UPDATE is fired when they are spent or when honor is calculated for the day.