WoW:API SetBindingClick - Revision history

Move page script: Move page script moved page API SetBindingClick to WoW:API SetBindingClick without leaving a redirect

2023-08-15T04:47:16Z

Move page script moved page API SetBindingClick to API SetBindingClick without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Starlightblunder: silly dash.

2010-04-29T00:24:53Z

silly dash.

← Older revision		Revision as of 00:24, 29 April 2010
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"]);

WoWWiki>Egingell: /* Details */

2010-04-13T00:26:53Z

Details

← Older revision		Revision as of 00:26, 13 April 2010
Line 13:		Line 13:
	== Details ==		== Details ==
	* This function is functionally equivalent to the following statement.		* This function is functionally equivalent to the following statement.
	ok = {{api\|SetBinding}}("key", "CLICK " .. ~~spell~~ .. (button and (":" .. button) or ""));		ok = {{api\|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.		* 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 {{api\|SetBinding}} to unbind a key.		* You must use {{api\|SetBinding}} to unbind a key.

WoWWiki>Starlightblunder at 13:42, 14 March 2010

2010-03-14T13:42:51Z

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} {{protectedcombatapi|2.0|Snippets executed by [[SecureHandlers]] may alter [override] bindings in-combat.}}
-<center>'''SetBindingClick'''</center>
+Sets a binding to click the specified button object.
-Binds a key or button press to a frame that's clickable.  Unbinds the key or button if the ''command'' argument is nil.
+== Arguments ==
-There does not appear to be a limit to the number of keys you can bind to a command.  The GUI key binding window will only show you the first two.  But if you set 5 different keys to the same command, they will all work.
+== Returns ==
-A single key can only be bound to one command.  Binding a key to a command that is already bound to another command will result in un-binding the key from the previous command.
+== Details ==
-If the function succeeds, the keys are usable immediately in game and will appear in the GUI key bindings window.  However, they are not written to disk unless [[API SaveBindings|SaveBindings()]] is called.  [[API SaveBindings|SaveBindings()]] is not called as part of the normal Logout procedure, so you either have to call it manually or open the GUI key binding window and click Okay.
+==See Also==
+* {{api|SetBinding}}

WoWWiki>Egingell: New page: {{wowapi}} '''SetBindingClick''' Binds a key or button press to a frame that's clickable. Unbinds the key or button if the ''command'' argument is nil. There does not a...

2008-10-10T12:19:03Z

New page: {{wowapi}} <center>'''SetBindingClick'''</center> Binds a key or button press to a frame that's clickable. Unbinds the key or button if the ''command'' argument is nil. There does not a...

New page

{{wowapi}}
<center>'''SetBindingClick'''</center>

Binds a key or button press to a frame that's clickable. Unbinds the key or button if the ''command'' argument is nil.

There does not appear to be a limit to the number of keys you can bind to a command. The GUI key binding window will only show you the first two. But if you set 5 different keys to the same command, they will all work.

A single key can only be bound to one command. Binding a key to a command that is already bound to another command will result in un-binding the key from the previous command.

If the function succeeds, the keys are usable immediately in game and will appear in the GUI key bindings window. However, they are not written to disk unless [[API SaveBindings|SaveBindings()]] is called. [[API SaveBindings|SaveBindings()]] is not called as part of the normal Logout procedure, so you either have to call it manually or open the GUI key binding window and click Okay.

SetBindingClick doesn't appears to work if your character is in combat. (2.0.1)

----
;''Arguments''

:(String key, String frameName, button)

:;key : (string) Key name of the key to bind (e.g. W, CTRL-F, BUTTON2). ''As of 1.6 there is now error checking on this value so random strings for key names won't work anymore.''
:;frameName: (string) Frame to click when the key is pressed (e.g. "ActionButton2", "ChatFrame1Tab"). This argument is optional. If not included, the function will un-bind the key argument. Also, using an invalid command will also un-bind the key specified.
:;button: (string) The button to simulate a click with (e.g. "RightButton", "LeftButton"). The Default is "LeftButton".

----
;''Returns''

:;success : 1 if the binding succeeded. nil if it failed or the key was unbound.

----
;''Note:''
:This is equivalent to [[API SetBinding|SetBinding]](key, "CLICK " .. frameName .. ":" .. button)