WoW:API ActionButtonUp: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{framexml}})
(Styling and some info)
Line 1: Line 1:
{{framexml}}
{{framexml}}
 
__NOTOC__
<center>'''ActionButtonUp''' ''-Documentation by AlexanderYoshi''</center>
<center>'''ActionButtonUp''' ''-Documentation by AlexanderYoshi''</center>


Release the specified action button.
Release the specified action button.


  ActionButtonUp(buttonID, onSelf);
  ActionButtonUp(buttonID [, onSelf]);


----
==Parameters==
;''Arguments''
===Arguments===
:(Number buttonID [,onSelf])


:(Number buttonID)
:;buttonID : The button ID of the button to release (Integers from 1 to 12)
:;onSelf : if evaluates to true, casts on yourself no matter the target (See [[API CastSpellByName]])


:;buttonID : The button ID of the button to release
===Returns===
:;nil


:(??? onSelf)
:;onSelf : ???
----
;''Returns''
:;nil


----
==Example==
;''Example''
  ActionButtonUp(1);
  ActionButtonUp(1);


;''Result''
===Result===
:#Checks if BonusActionBarFrame is Visible.
:#Checks if BonusActionBarFrame is Visible.
:#On True -
:#On True -
Line 51: Line 46:
:###Changes Button 1's SetChecked value to 1.
:###Changes Button 1's SetChecked value to 1.


----
===Description===
;''Description''
:Changes buttonID's state to NORMAL.
:Changes buttonID's state to NORMAL.
:<I>NOTE:</I> Works with ActionBarFrame & BonusActionBarFrame.
:<I>NOTE:</I> Works with ActionBarFrame & BonusActionBarFrame.

Revision as of 11:09, 27 August 2006

WoW API < ActionButtonUp

ActionButtonUp -Documentation by AlexanderYoshi

Release the specified action button.

ActionButtonUp(buttonID [, onSelf]);

Parameters

Arguments

(Number buttonID [,onSelf])
buttonID
The button ID of the button to release (Integers from 1 to 12)
onSelf
if evaluates to true, casts on yourself no matter the target (See API CastSpellByName)

Returns

nil


Example

ActionButtonUp(1);

Result

  1. Checks if BonusActionBarFrame is Visible.
  2. On True -
    1. Checks if BonusActionButton1 is in state PUSHED.
    2. On True -
      1. Changes BonusActionButton1 to state NORMAL.
      2. If currently editing/writing macro saves the action.
      3. Uses the action associated with the BonusActionButton1
      4. Checks if it's the current action.
      5. If True -
        1. Changes Button 1's SetChecked value to 1.
      6. Else -
        1. Changes Button 1's SetChecked value to 0.
  3. Returns - Ending Function call.
  4. Checks if ActionButton1 is in state PUSHED.
  5. On True -
    1. Changes ActionButton1 to state NORMAL.
    2. If currently editing/writing macro saves the action.
    3. Uses the action associated with the ActionButton1.
    4. Checks if it's the current action.
    5. If True -
      1. Changes Button 1's SetChecked value to 1.
    6. Else -
      1. Changes Button 1's SetChecked value to 1.

Description

Changes buttonID's state to NORMAL.
NOTE: Works with ActionBarFrame & BonusActionBarFrame.