WoW:API SetBindingClick: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Move page script moved page API SetBindingClick to API SetBindingClick without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{wowapi}} {{protectedcombatapi|2.0|Snippets executed by [[SecureHandlers]] may alter [override] bindings in-combat.}}
{{wowapi}} {{protectedcombatapi|2.0|Snippets executed by [[SecureHandlers]] may alter [override] bindings while in combat.}}
Sets a binding to click the specified button object.
Sets a binding to click the specified button object.
  ok = SetBindingClick("key", "buttonName"[, "button"]);
  ok = SetBindingClick("key", "buttonName"[, "button"]);

Latest revision as of 04:47, 15 August 2023

WoW API < SetBindingClick

Sets a binding to click the specified button object.

ok = SetBindingClick("key", "buttonName"[, "button"]);

Arguments[edit]

key
String - Any binding string accepted by World of Warcraft. For example: "ALT-CTRL-F", "SHIFT-T", "W", "BUTTON4".
buttonName
String - Name of the button you wish to click.
button
String - Value of the button argument you wish to pass to the OnClick handler with the click; "LeftButton" by default.

Returns[edit]

ok
Flag - 1 if the binding has been changed successfully, nil otherwise.

Details[edit]

  • This function is functionally equivalent to the following statement.
ok = SetBinding("key", "CLICK " .. buttonName .. (button and (":" .. button) or ""));
  • A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command.
  • You must use SetBinding to unbind a key.

See Also[edit]