WoW:API GetBonusBarOffset: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Spacing)
Line 1: Line 1:
<center>'''GetBonusBarOffset''' - ''Documentation by [[User:Flickering|Flickering]]''</center>
{{wowapi}} __NOTOC__
 
Returns the current bonus action bar index.
{{Code/Begin}}
offset = GetBonusBarOffset()
{{Code/End}}


Determine which page of bonus actions to show.


offset = GetBonusBarOffset()
== Parameters ==
== Parameters ==
=== Arguments ===
<big>'''Arguments'''</big>
:()
:NONE
 
<big>'''Returns'''</big>
 
:;offset - Number : The current bonus action bar index.
 
== Details ==
Certain classes have "bonus action bars" for their class-specific actions, e.g. the various [[Stance|Stance Bars]] for the [[Warrior]] class.  GetBonusBarOffset() returns the index of the current action bar that is being displayed.  Note that simply scrolling through the action bar pages won't change the output; only switching to the different bonus bars.  Each class has their own way of indexing their bonus bars.
 
'''Warrior'''
* Battle Stance: 1
* Defensive Stance: 2
* Berserker Stance: 3
 
'''Druid'''
* ???
 
'''Rogue'''
* Normal: 0
* Stealthed: 1


=== Returns ===
== Example ==
:offset
{{Code/Begin}}
/script ChatFrame1:AddMessage(GetBonusBarOffset())
{{Code/End}}
:This will simply print the output of GetBonusBarOffset().  It should change as you change between your bonus bars.


:;offset : Numeric - 0 if the player has no current bonus actions, otherwise the bonus action page to show, starting at 1 (This is for warriors, rogues, druids, etc, who have multiple action bars for their different forms/stances). The first slot of the current action bar is (1 + (NUM_ACTIONBAR_PAGES + offset - 1) * NUM_ACTIONBAR_BUTTONS).
{{Code/Begin}}
----
slotID = (1 + (NUM_ACTIONBAR_PAGES + GetBonusBarOffset() - 1) * NUM_ACTIONBAR_BUTTONS)
__NOTOC__
{{Code/End}}
{{Template:WoW API}}
: Here, slotID will be the action slot number for the first slot of the current bonus bar.  For example, for a Warrior in Defensive Stance, <tt>slotID = 85</tt>, which is correct.[http://www.wowwiki.com/ActionSlot]

Revision as of 23:10, 16 October 2006

← WoW API < GetBonusBarOffset

Returns the current bonus action bar index. Template:Code/Begin offset = GetBonusBarOffset() Template:Code/End


Parameters

Arguments

NONE

Returns

offset - Number
The current bonus action bar index.

Details

Certain classes have "bonus action bars" for their class-specific actions, e.g. the various Stance Bars for the Warrior class. GetBonusBarOffset() returns the index of the current action bar that is being displayed. Note that simply scrolling through the action bar pages won't change the output; only switching to the different bonus bars. Each class has their own way of indexing their bonus bars.

Warrior

  • Battle Stance: 1
  • Defensive Stance: 2
  • Berserker Stance: 3

Druid

  • ???

Rogue

  • Normal: 0
  • Stealthed: 1

Example

Template:Code/Begin /script ChatFrame1:AddMessage(GetBonusBarOffset()) Template:Code/End

This will simply print the output of GetBonusBarOffset(). It should change as you change between your bonus bars.

Template:Code/Begin slotID = (1 + (NUM_ACTIONBAR_PAGES + GetBonusBarOffset() - 1) * NUM_ACTIONBAR_BUTTONS) Template:Code/End

Here, slotID will be the action slot number for the first slot of the current bonus bar. For example, for a Warrior in Defensive Stance, slotID = 85, which is correct.[1]
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetBonusBarOffset&oldid=11298"