Wikia

WoWWiki

Changes: API GetBagName

Edit

Back to page

m (Corrected internal link.)
 
Line 18: Line 18:
 
;''Result''
 
;''Result''
   
: bagName will contain the name of the specified bag if the bag number is 0-4 otherwise it will be nil, unless when the bank is opened, in which case GetBagName(-1) (for the bank) is nil and GetBagName(6) will give the name of the first bank bag, GetBagName(7) the name of the second bank bag, etc ...
+
: bagName will contain the name of the specified bag if the bag number is 0-4 otherwise it will be nil, unless when the bank is opened, in which case GetBagName(-1) (for the bank) is nil and GetBagName(5) will give the name of the first bank bag, GetBagName(6) the name of the second bank bag, etc ... When coding, use the global variables (NUM_BAG_SLOTS, etc, ...) instead of hard coding these numbers, in case they change in the future. For details, see [[BagId]].
   
 
----
 
----

Latest revision as of 18:40, April 21, 2011

WoW API < GetBagName
Arguments
(bagID)
bagID 
number - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags, numbered right to left. Actually, for this method, this parameter is valid as API_ContainerIDToInventoryID.

Returns
bagName
bagName - the name of the specified bag (example "Green Woolen Bag")

Examples
local bagName = GetBagName(0);  
-- Returns localized "Backpack".

Result
bagName will contain the name of the specified bag if the bag number is 0-4 otherwise it will be nil, unless when the bank is opened, in which case GetBagName(-1) (for the bank) is nil and GetBagName(5) will give the name of the first bank bag, GetBagName(6) the name of the second bank bag, etc ... When coding, use the global variables (NUM_BAG_SLOTS, etc, ...) instead of hard coding these numbers, in case they change in the future. For details, see BagId.

Notes
It seems that there is no way to check the keyholder name; GetContainerNumSlots and GetBagName returns 32 and nil while bagID is -2.
GetBagName(-2) - returns nil
GetContainerNumSlots(-2) - always returns 32

Around Wikia's network

Random Wiki