WoW:API ChangeActionBarPage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
Line 1: Line 1:
{{wowapi}}
{{wowapi}}


Changes the current action button set to the one specified in CURRENT_ACTIONBAR_PAGE variable.
Changes the current action button to the one specified in the arguments.


  ChangeActionBarPage()
  ChangeActionBarPage(actionBarPage)
== Parameters ==
== Parameters ==
=== Arguments ===
=== Arguments ===
:()
:(actionBarPage)
 
:;actionBarPage : Numeric - Which page of your action bar to switch to. Expects an integer 1-6.


=== Returns ===
=== Returns ===
Line 13: Line 15:
== Example ==
== Example ==
<!-- begin code -->
<!-- begin code -->
  function ActionBar_PageUp()
  function ActionBar_FirstPage()
     CURRENT_ACTIONBAR_PAGE = CURRENT_ACTIONBAR_PAGE + 1;
     ChangeActionBarPage(1);
    if ( CURRENT_ACTIONBAR_PAGE &gt; NUM_ACTIONBAR_PAGES ) then
      CURRENT_ACTIONBAR_PAGE = 1;
    end
    ChangeActionBarPage();
  end
  end
<!-- end code -->
<!-- end code -->
==== Result ====
 
:This function does the same thing as pressing the Page Up button. It increments CURRENT_ACTIONBAR_PAGE, checks for a valid page number, then calls ChangeActionBarPage() to change the action bar.
Or for a macro:
 
<!-- begin code -->
/script ChangeActionBarPage(2);
<!-- end code -->


== Details ==
== Details ==
Line 29: Line 31:
: Will cause an ACTIONBAR_PAGE_CHANGED event to fire (Whether the event fires when there hasn't actually been a change is untested).
: Will cause an ACTIONBAR_PAGE_CHANGED event to fire (Whether the event fires when there hasn't actually been a change is untested).


: In 2.0.1, this appears to have been changed to require an argument (e. g., ChangeActionBarPage(4) would change to page 4.)  Can someone confirm this?


----
----
__NOTOC__
__NOTOC__

Revision as of 06:45, 14 December 2006

WoW API < ChangeActionBarPage

Changes the current action button to the one specified in the arguments.

ChangeActionBarPage(actionBarPage)

Parameters

Arguments

(actionBarPage)
actionBarPage
Numeric - Which page of your action bar to switch to. Expects an integer 1-6.

Returns

nil

Example

function ActionBar_FirstPage()
   ChangeActionBarPage(1);
end

Or for a macro:

/script ChangeActionBarPage(2);

Details

Notifies the UI that the current action button set has been updated to the current value of the CURRENT_ACTIONBAR_PAGE global variable.
Will cause an ACTIONBAR_PAGE_CHANGED event to fire (Whether the event fires when there hasn't actually been a change is untested).