WoW:API OpenAllBags: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API OpenAllBags to API OpenAllBags without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}}
{{framexmlfunc|FrameXML/ContainerFrame.lua}}
=== Function ===
OpenAllBags(forceOpen)
''OpenAllBags(Parameter);''
----


=== Parameters ===
=== Parameters ===
; true : Opens all bags including the quiver.
* forceOpen (boolean)
; false : Opens no bags. Obiviously useless :P
** nil - Leaving the ( ) empty will enable the ''toggle'' function of the macro.
; nil : Leaving the ( ) empty will enable the ''toggle'' function of the macro.
** true - Opens all bags including the quiver.
----
** false - Does the same thing as '''nil'''.


=== Details ===
=== Details ===
I use this in a simple macro that quickly opens all bags. This is useful since when activated, it will open the remnant bags that did not opened when talking to a vendor or opening your bank account '''without''' closing the backpack.
* Note: forceOpen as nil will close all of your bags if they're all open. If you want to open all of your bags and keep them open when the event fires a second time while the bags are still open, call ''OpenAllBags''('''true''')
:: ''/script OpenAllBags();''
 
<br>
* I use this in a simple macro that quickly opens all bags. This is useful since when activated, it will open the remnant bags that did not opened when talking to a vendor or opening your bank account '''without''' closing the backpack.
It also opens the quiver. To override this, you can add  
''/script OpenAllBags();''
<br>
* It also opens the quiver. To override this, you can add  
:: ''/script [[API_ToggleBag|ToggleBag]](''quiver position number'');''
''/script [[API_ToggleBag|ToggleBag]](''quiver position number'');''
to the macro but unfortunately, when you will use the macro again, it will close all bags BUT open the quiver.<br>I couldn't find anyway around yet.
to the macro but unfortunately, when you will use the macro again, it will close all bags BUT open the quiver.<br>I couldn't find anyway around yet.
* This function does ''not'' open the Key Ring.

Latest revision as of 04:46, 15 August 2023

WoW API < OpenAllBags

"I" iconThis function is implemented in Lua here FrameXML/ContainerFrame.lua.
OpenAllBags(forceOpen)

Parameters[edit]

  • forceOpen (boolean)
    • nil - Leaving the ( ) empty will enable the toggle function of the macro.
    • true - Opens all bags including the quiver.
    • false - Does the same thing as nil.

Details[edit]

  • Note: forceOpen as nil will close all of your bags if they're all open. If you want to open all of your bags and keep them open when the event fires a second time while the bags are still open, call OpenAllBags(true)
  • I use this in a simple macro that quickly opens all bags. This is useful since when activated, it will open the remnant bags that did not opened when talking to a vendor or opening your bank account without closing the backpack.
/script OpenAllBags();
  • It also opens the quiver. To override this, you can add
/script ToggleBag(quiver position number);

to the macro but unfortunately, when you will use the macro again, it will close all bags BUT open the quiver.
I couldn't find anyway around yet.

  • This function does not open the Key Ring.