WoW:API RunBinding: Difference between revisions
Jump to navigation
Jump to search
RunBinding -Documentation by Lego-
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{API | <center>'''RunBinding''' ''-Documentation by [[user:Lego|Lego]]-''</center> | ||
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> | |||
Executes a key binding as if a key was pressed. | |||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | |||
RunBinding("command" {,"up"}); | |||
=== Arguments === | |||
<!-- List each argument, together with its type --> | |||
:("command" {,"up"}) | |||
:;command : String - Name of the key binding to be executed | |||
:;up : String - The string literal "up". If specified, the binding is run as if the key was released. | |||
== Example == | |||
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory --> | |||
RunBinding("TOGGLEFPS"); | |||
Toggles the display of the FPS counter, as if CTRL+R was pressed. | |||
==Details== | |||
<!-- Details not appropriate for the main description can go here --> | |||
The "command" argument must match one of the (usually capitalized) binding names in a Bindings.xml file. This can be a name that appears in the Blizzard FrameXML Bindings.xml, or one that is specified in an AddOn. | |||
By default, the key binding is executed as if the key was pressed down, in other words the keystate variable will have value "down" during the binding's execution. By specifying the optional second argument (the actual string "up"), the binding is instead executed as if the key was released, in other words the keystate variable will have value "up" during the binding's execution. | |||
---- | |||
__NOTOC__ | |||
{{Template:WoW API}} | |||
Revision as of 02:18, 9 March 2006
Executes a key binding as if a key was pressed.
RunBinding("command" {,"up"});
Arguments
- ("command" {,"up"})
- command
- String - Name of the key binding to be executed
- up
- String - The string literal "up". If specified, the binding is run as if the key was released.
Example
RunBinding("TOGGLEFPS");
Toggles the display of the FPS counter, as if CTRL+R was pressed.
Details
The "command" argument must match one of the (usually capitalized) binding names in a Bindings.xml file. This can be a name that appears in the Blizzard FrameXML Bindings.xml, or one that is specified in an AddOn.
By default, the key binding is executed as if the key was pressed down, in other words the keystate variable will have value "down" during the binding's execution. By specifying the optional second argument (the actual string "up"), the binding is instead executed as if the key was released, in other words the keystate variable will have value "up" during the binding's execution.