WoW:UIHANDLER OnTooltipAddMoney: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Rewrite to better describe what actually happens - it's a script handler, not a function!)
Line 1: Line 1:
<center>'''GameTooltip:OnTooltipAddMoney''' ''-Documentation by [[User:Greenman|Greenman]]-''</center>
{{widgetmethod}}


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Invoked when money information needs to be added to a tooltip.
GameTooltip:OnTooltipAddMoney(money);


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
== Arguments ==
Called when the money amount and graphics are added to the tooltip text.


----
:;arg1: Number - amount of money to add, in copper pieces.
;''Arguments''


<!-- List each argument, together with its type -->
== Example ==
:(money)
:;money : integer - amount of money to add, in copper pieces.
 
----
;''Returns''
 
<!-- List each return value, together with its type -->
: The function returns nothing.
 
----
;''Example''
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->


  -- overload the base function with a custom routine
  -- overload the base function with a custom routine
Line 34: Line 19:




----
== Details ==
;''Details''
: This function was added in v1.7 and replaces the functionality that used to be provided by trapping the TOOLTIP_ADD_MONEY event. It is most commonly used to get merchant sell values when you scan the items in the inventory.
 
: This function is new for 1700. It replaces the functionality that used to be provided by trapping the TOOLTIP_ADD_MONEY event. It is most commonly used to get merchant sell values when you scan the items in the inventory.
 
 
----
{{WoW API}}

Revision as of 05:41, 7 August 2006

← Widget API ← OnTooltipAddMoney < OnTooltipAddMoney

Invoked when money information needs to be added to a tooltip.

Arguments

arg1
Number - amount of money to add, in copper pieces.

Example

-- overload the base function with a custom routine
Saved_OnTooltipAddMoney = MyTooltip:GetScript("OnTooltipAddMoney");
MyTooltip:SetScript("OnTooltipAddMoney", My_OnTooltipAddMoney);
-- my custom routine
function My_OnTooltipAddMoney ()
  Saved_OnTooltipAddMoney();
  -- do something extra with the money amount in arg1
end


Details

This function was added in v1.7 and replaces the functionality that used to be provided by trapping the TOOLTIP_ADD_MONEY event. It is most commonly used to get merchant sell values when you scan the items in the inventory.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:UIHANDLER_OnTooltipAddMoney&oldid=5778"