WoW:API SetBinding - Revision history

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

2023-08-15T04:47:16Z

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

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

WoWWiki>Egingell: /* Details */ ... on second thought, there is an option to not store bindings on the server.

2010-03-14T23:50:55Z

Details: ... on second thought, there is an option to not store bindings on the server.

← Older revision		Revision as of 23:50, 14 March 2010
Line 18:		Line 18:

	== Example ==		== Example ==
	-- ~~Removes~~ the ~~default~~ right mouse button ~~binding~~		-- Remove all bindings from the right mouse button.
	SetBinding("BUTTON2");		SetBinding("BUTTON2");
	-- ~~Restores~~ the default ~~behavior~~ for the right mouse button		-- Restore the default binding for the right mouse button.
	SetBinding("BUTTON2","TURNORACTION");		SetBinding("BUTTON2","TURNORACTION");

Line 28:		Line 28:
	* The Key Bindings UI will update immediately should this function succeed. However, bindings are not saved without an explicit {{api\|SaveBindings}}() call. Unless saved, bindings will reset on next log-in / bindings load.		* The Key Bindings UI will update immediately should this function succeed. However, bindings are not saved without an explicit {{api\|SaveBindings}}() call. Unless saved, bindings will reset on next log-in / bindings load.
	* A list of default FrameXML bindings.xml-defined actions is available: [[BindingID]].		* A list of default FrameXML bindings.xml-defined actions is available: [[BindingID]].
			* The Addon API doesn't know what the default binding is for any single action. You can set them all to their defaults by calling <code>{{api\|LoadBindings}}(DEFAULT_BINDINGS)</code>; this is an all-or-nothing action.

	==See Also==		==See Also==

WoWWiki>Starlightblunder: /* Arguments */

2010-03-14T12:32:53Z

Arguments

@@ Line 1: / Line 1: @@
-{{wowapi}}
+{{wowapi}} {{protectedcombatapi|2.0|Snippets executed by [[SecureHandlers]] may alter [override] bindings in-combat.}}
-<center>'''SetBinding'''</center>
+Alters the action performed by a binding.
-Binds a key or button press to a command.  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.
+== Example ==
+  -- Removes the default right mouse button binding
-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.
+  SetBinding("BUTTON2");
+  -- Restores the default behavior for the right mouse button
   SetBinding("BUTTON2","TURNORACTION");
 ==See Also==
 * [[API SetBindingSpell]]

WoWWiki>Egingell at 04:15, 10 March 2010

2010-03-10T04:15:41Z

← Older revision		Revision as of 04:15, 10 March 2010
Line 15:		Line 15:
	;''Arguments''		;''Arguments''

	:(String key, String command)		:(String key, String [[BindingID\|command]])

	:;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.''		:;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.''
Line 34:		Line 34:

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


			----
			==See Also==
			* [[API SetBindingSpell]]
			* [[API SetBindingItem]]
			* [[API SetBindingMacro]]
			* [[API SetBindingClick]]

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T18:07:35Z

upgraded deprecated template

← Older revision		Revision as of 18:07, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	<center>'''SetBinding'''</center>		<center>'''SetBinding'''</center>

Line 33:		Line 34:

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

	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>Cerdor: Added a note that SetBinding does not work in combat as of 2.0.1.

2006-12-16T16:10:38Z

Added a note that SetBinding does not work in combat as of 2.0.1.

← Older revision		Revision as of 16:10, 16 December 2006
Line 8:		Line 8:

	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.		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.

			SetBinding no longer appears to work if your character is in combat. (2.0.1)

	----		----

WoWWiki>Anticrash at 15:05, 4 January 2006

2006-01-04T15:05:33Z

← Older revision		Revision as of 15:05, 4 January 2006
Line 34:		Line 34:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
	~~[[Category:API Functions\|SetBinding]]~~
	~~[[Category:API Key Binding Functions\|SetBinding]]~~

WoWWiki>Aalnydara: tiny grammar mod

2005-09-15T15:35:55Z

tiny grammar mod

← Older revision		Revision as of 15:35, 15 September 2005
Line 1:		Line 1:
	<center>'''SetBinding'''</center>		<center>'''SetBinding'''</center>

	Binds a key or button press to an command. Unbinds the key or button if the ''command'' argument is nil.		Binds a key or button press to a command. 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.		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.

WoWWiki>Inglais at 18:41, 29 August 2005

2005-08-29T18:41:10Z

← Older revision		Revision as of 18:41, 29 August 2005
Line 34:		Line 34:
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}
			[[Category:API Functions\|SetBinding]]
			[[Category:API Key Binding Functions\|SetBinding]]

WoWWiki>Aalnydara: Added 1.6 change

2005-07-21T01:43:52Z

Added 1.6 change

← Older revision		Revision as of 01:43, 21 July 2005
Line 1:		Line 1:
	<center>'''~~SetBindings~~'~~'' ''-Documentation by Sn3b-~~''</center>		<center>'''SetBinding'''</center>

	Binds a key to an ~~action~~.		Binds a key or button press to an command. Unbinds the key or button if the ''command'' argument is nil.

	~~SetBindings~~();		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.

	----		----
	;''Arguments''		;''Arguments''

	:("key", "command")		:(String key, String command)
	:;key: ~~String - key~~ name of the key to bind (eg, BUTTON2 ~~= right mouse click~~)
	:;command: ~~String - action/command~~ to ~~perform~~ when the key ~~"key"~~ is pressed		:;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.''
			:;command : (string) Command name to execute when the key is pressed (e.g. MOVEFORWARD, TOGGLECHARACTER0). 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.

	----		----
	;''Example''		;''Example''

			-- Set the default behavior for the right mouse button
	SetBinding("BUTTON2","TURNORACTION");		SetBinding("BUTTON2","TURNORACTION");
			-- Set the W key to move forward
			SetBinding("W", "MOVEFORWARD");
			-- Unset the key combination Ctrl+F
			SetBinding("CTRL-F");

	----		----
	;''Returns''		;''Returns''

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

	~~(tho I guess~~ it ~~might return true when~~ the ~~binding method has run successfully)~~

	~~----~~
	~~;''Description''~~

	~~: Will bind a~~ key ~~to an action~~.

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


	~~--[[User:Sn3b\|Sn3b]] 10:25, 28 Feb 2005 (EST)~~