WoW:API TakeInboxMoney: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 3: Line 3:


<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
One line summary description of function.
Take all money attached in a given letter in your inbox


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Line 14: Line 14:
:(index)
:(index)


:;Index : Integer - a number representing a message in the inbox
:;index: Number - a number representing a message in the inbox


=== Returns ===
=== Returns ===
<!-- List each return value, together with its type -->
<!-- List each return value, together with its type -->
Void
:nil


== Example ==
== Example ==
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
For i=GetInboxNumItems(), 0, -1 do TakeInboxMoney(i) end;
for i=GetInboxNumItems(), 1, -1 do  
 
  TakeInboxMoney(i);
====Result====
end;
<!-- 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. -->

Revision as of 09:20, 7 July 2006

WoW API < TakeInboxMoney


Take all money attached in a given letter in your inbox

TakeInboxMoney(index)


Parameters

Arguments

(index)
index
Number - a number representing a message in the inbox

Returns

nil

Example

for i=GetInboxNumItems(), 1, -1 do 
  TakeInboxMoney(i); 
end;