WoW:API GetHonorCurrency: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetHonorCurrency to API GetHonorCurrency without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi|removed=4.0|replace=Replaced by {{api|GetCurrencyInfo}}}}


Gets the amount of spendable honor points the player has


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
local points = GetHonorCurrency()
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 (number) - Amount of honor points that the player has available and can spend


<big>'''Arguments'''</big>
== Details ==
<!-- List each argument, together with its type -->
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.
:;None known
 
 
<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==
== Notes ==
<!-- Details not appropriate for the main description can go here.  
* This function has been removed in patch 4.0, in the Cataclysm beta. See {{api|GetCurrencyInfo}}
    REMOVE the section if you're just going to restate the intro line! -->

Latest revision as of 04:45, 15 August 2023

WoW API < GetHonorCurrency

Gets the amount of spendable honor points the player has

local points = GetHonorCurrency()

Parameters[edit]

Returns[edit]

  • points (number) - Amount of honor points that the player has available and can spend

Details[edit]

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.

Notes[edit]

  • This function has been removed in patch 4.0, in the Cataclysm beta. See GetCurrencyInfo