WoW:API ChangeActionBarPage: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API ChangeActionBarPage to API ChangeActionBarPage without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''ChangeActionBarPage''' - ''Documentation by The Nerd Wonder''</center>
{{wowapi}}


Changes the current action button set.
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 ===
:<i>nil</i>
:''nil''


== 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 ==
: Notifies the UI that the current action button set has been updated to the current value of the CURRENT_ACTIONBAR_PAGE global variable.
: 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).
: Will cause an ACTIONBAR_PAGE_CHANGED event to fire only if there was actually a change (tested in 2.3.0).
 
: Do nothing in combat mode


----
----
__NOTOC__
__NOTOC__
{{Template:WoW API}}

Latest revision as of 04:45, 15 August 2023

← WoW API < ChangeActionBarPage

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

ChangeActionBarPage(actionBarPage)

Parameters[edit]

Arguments[edit]

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

Returns[edit]

nil

Example[edit]

function ActionBar_FirstPage()
   ChangeActionBarPage(1);
end

Or for a macro: 

/script ChangeActionBarPage(2);

Details[edit]

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 only if there was actually a change (tested in 2.3.0).
Do nothing in combat mode
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_ChangeActionBarPage&oldid=18633"