WoW:API ToggleBag: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
({{framexmlfunc|FrameXML/ContainerFrame.lua}} __NOTOC__)
Line 1: Line 1:
<center>'''ToggleBag''' ''-Documentation by AlexanderYoshi-''</center>
{{framexmlfunc|FrameXML/ContainerFrame.lua}} __NOTOC__


Opens or closes the specified bag.


  ToggleBag(bagNum);
  ToggleBag(bagNum);


----
Opens or closes the specified bag.
;''Arguments''
 


:(Number bagNum)
== Parameters ==
=== Arguments ===


:;bagNum : The number of which bag you want to toggle open or close
:;bagNum : Number - the [[bagId]] you want to toggle open or close


----
=== Returns ===
;''Returns''


:;nil
:;nil


----
== Example ==
;''Example''
 
  ToggleBag(2);
  ToggleBag(2);
;''Result''
----
;''Description''
: Opens or closes the specified bag.




: NOTE:
== Details ==
: If toggling the backpack with the keyboard, this function is called when opening but NOT when closing. Closing appears to be done by ToggleBackpack(). However, if the mouse is used to close the Backpack then this function does respond.
: If toggling the backpack with the keyboard, this function is called when opening but NOT when closing. Closing appears to be done by ToggleBackpack(). However, if the mouse is used to close the Backpack then this function does respond.
----
{{WoW API}}

Revision as of 14:05, 5 September 2006

← WoW API < ToggleBag

"I" iconThis function is implemented in Lua here FrameXML/ContainerFrame.lua.


ToggleBag(bagNum);

Opens or closes the specified bag.


Parameters

Arguments

bagNum
Number - the bagId you want to toggle open or close

Returns

nil

Example

ToggleBag(2);


Details

If toggling the backpack with the keyboard, this function is called when opening but NOT when closing. Closing appears to be done by ToggleBackpack(). However, if the mouse is used to close the Backpack then this function does respond.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_ToggleBag&oldid=7623"