WoW:API ActionButtonUp: Difference between revisions

Latest revision as of 04:45, 15 August 2023

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < ActionButtonUp

This function is implemented in Lua here FrameXML/ActionButton.lua.

ActionButtonUp(buttonID [, onSelf]);

Releases the specified action button.

Parameters[edit]

Arguments[edit]

(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[edit]

nil

Example[edit]

ActionButtonUp(1);

Result[edit]

Checks if BonusActionBarFrame is Visible.
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.
Returns - Ending Function call.
Checks if ActionButton1 is in state PUSHED.
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[edit]

Changes buttonID's state to NORMAL.

NOTE: Works with ActionBarFrame & BonusActionBarFrame.

@@ Line 1: / Line 1: @@
- <center>'''ActionButtonUp''' ''-Documentation by AlexanderYoshi-''</center>
+{{protectedapi|2.0|}}
+{{framexmlfunc|FrameXML/ActionButton.lua}}
-Release the specified action button.
+ ActionButtonUp(buttonID [, onSelf]);
- ActionButtonUp(buttonID);
+Releases the specified action button.
-----
+==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''
+===Returns===
 :;nil
-----
+==Example==
-;''Example''
   ActionButtonUp(1);
-;''Result''
+===Result===
+:#Checks if BonusActionBarFrame is Visible.
-----
+:#On True -
-;''Description''
+:##Checks if BonusActionButton1 is in state PUSHED.
+:##On True -
-: Release the specified action button.
+:###Changes BonusActionButton1 to state NORMAL.
+:###If currently editing/writing macro saves the action.
+:###Uses the action associated with the BonusActionButton1
+:###Checks if it's the current action.
+:###If True -
+:####Changes Button 1's SetChecked value to 1.
+:###Else -
+:####Changes Button 1's SetChecked value to 0.
+:#Returns - Ending Function call.
+:#Checks if ActionButton1 is in state PUSHED.
+:#On True -
+:##Changes ActionButton1 to state NORMAL.
+:##If currently editing/writing macro saves the action.
+:##Uses the action associated with the ActionButton1.
+:##Checks if it's the current action.
+:##If True -
+:###Changes Button 1's SetChecked value to 1.
+:##Else -
+:###Changes Button 1's SetChecked value to 1.
-----
+==Description==
-{{Template:WoW API}}
+:Changes buttonID's state to NORMAL.
+:''NOTE:'' Works with ActionBarFrame & BonusActionBarFrame.

Navigation menu

Search