WoW:API BuyMerchantItem: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API BuyMerchantItem to API BuyMerchantItem without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''BuyMerchantItem''' ''-Documentation by [[user:Fenaoin|Fenaoin]]-''</center>
{{wowapi}} __NOTOC__
 
Buys the specified item.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  BuyMerchantItem(index {, quantity});
  BuyMerchantItem(index {, quantity});


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
==Parameters==
Buys the specified item.
===Arguments===
----
;''Arguments''
 
<!-- List each argument, together with its type -->
:(index {, quantity})
:;index : Number - The index of the item in the merchant's inventory
:;index : Number - The index of the item in the merchant's inventory
:;quantity : Number - Optional quantity to buy
:;quantity : Number (Optional) - Quantity to buy.
 
----
;''Returns''
 
:nothing
 
----
;''Details''
 
<!-- Details not appropriate for the main description can go here -->
: If the item is sold in stacks, the quantity specifies how many stacks will be bought.


----
==Notes==
{{Template:WoW API}}
If the item is sold in stacks, the quantity specifies how many stacks will be bought.  <-- This is either questionable or confusing.  For example, Crystal Vials are sold in batches of 5 by default.  Giving 2 as the quantity will purchase only 2 Crystal Vials, not 10.
[[Category:API Functions|BuyMerchantItem]]
[[Category:API Merchant Functions|BuyMerchantItem]]

Latest revision as of 04:45, 15 August 2023

← WoW API < BuyMerchantItem

Buys the specified item. 

BuyMerchantItem(index {, quantity});

Parameters[edit]

Arguments[edit]

index
Number - The index of the item in the merchant's inventory
quantity
Number (Optional) - Quantity to buy.

Notes[edit]

If the item is sold in stacks, the quantity specifies how many stacks will be bought. <-- This is either questionable or confusing. For example, Crystal Vials are sold in batches of 5 by default. Giving 2 as the quantity will purchase only 2 Crystal Vials, not 10.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_BuyMerchantItem&oldid=18571"