Changes: API ToggleBag

Revision as of 14:05, 5 September 2006

This function is implemented in 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.

@@ Line 1: / Line 1: @@
+{{framexmlfunc|FrameXML/ContainerFrame.lua}} __NOTOC__
-{{framexml}}
- <center>'''ToggleBag''' ''-Documentation by AlexanderYoshi-''</center>
+ ToggleBag(bagNum);
 Opens or closes the specified bag.
- ToggleBag(bagNum);
+== Parameters ==
-----
-;''Arguments''
+=== Arguments ===
+:;bagNum : Number - the [[bagId]] you want to toggle open or close
-:(Number bagNum)
+=== Returns ===
-:;bagNum : The number of which bag you want to toggle open or close
-----
-;''Returns''
 :;nil
+== Example ==
-----
-;''Example''
  ToggleBag(2);
-;''Result''
-----
-;''Description''
-: Opens or closes the specified bag.
+== Details ==
-: NOTE:
 : 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.