WoW:API GetBindingAction: Difference between revisions

Revision as of 00:03, 29 April 2010

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

Returns the name of the action performed by the specified binding.

action = GetBindingAction("binding"[, checkOverride]);

binding: String - The name of the key (eg. "BUTTON1", "1", "CTRL-G")
checkOverride: Optional boolean - if true, override bindings will be checked, otherwise, only default (bindings.xml/SetBinding) bindings are consulted.

action: String - action command performed by the binding. If no action is bound to the key, an empty string is returned.

@@ Line 1: / Line 1: @@
 {{wowapi}}
-<center>'''GetBindingAction'''</center>
+Returns the name of the action performed by the specified binding.
+ action = GetBindingAction("binding"[, checkOverride]);
-Returns the name of the action performed by the specified ''key''.
+==Arguments ==
+;binding : String - The name of the key (eg. "BUTTON1", "1", "CTRL-G")
+;checkOverride : Optional boolean - if true, override bindings will be checked, otherwise, only default (bindings.xml/SetBinding) bindings are consulted.
-----
+== Returns ==
-;''Arguments''
+; action : String - action command performed by the binding. If no action is bound to the key, an empty string is returned.
-:(String key)
-:;key : The name of the key (eg. BUTTON1, 1, CTRL-G)
-----
-;''Returns''
-:action
-:;action : The name of the action performed by the key.  If no action is bound to the key, an empty string is returned.
-----
-;''Example''
- action = GetBindingAction("UP");
- DEFAULT_CHAT_FRAME:AddMessage("The up arrow is currently bound to:",1.0,1.0,1.0);
- if (action) then DEFAULT_CHAT_FRAME:AddMessage(action,1.0,1.0,1.0); end
- --By default this will return "MOVEFORWARD"