API GetBindingText

103,497pages on
this wiki

WoW API < GetBindingText
Icon-information-22x22This function is implemented by FrameXML in FrameXML/UIParent.lua.

text = GetBindingText(key,prefix,abbreviate)

Returns the localized string value for the given key and prefix. Essentially a glorified getglobal() function.

Parameters Edit

Arguments Edit

(String key, String prefix, [Boolean abbreviate])
String - The name of the key (e.g. "UP", "SHIFT-PAGEDOWN")
String - The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_".
Boolean (optional) - Whether to return an abbreviated version of the modifier keys

Returns Edit

String - The value of the global variable derived from the prefix and key name you specified. For example, "UP" and "KEY_" would return the value of the global variable KEY_UP which is "Up Arrow" in the english locale. If the global variable doesn't exist for the combination specified, it appears to just return the key name you specified. Modifier key prefixes are stripped from the input and added back in to the output.

The third parameter, if true, causes the function to simply substitute the abbreviations 'c', 'a', 's', and 'st' for the strings CTRL, ALT, SHIFT, and STRG (German client only) in the result.

Example Edit

val = GetBindingText("UP", "KEY_");
-- val is "Up Arrow"

Around Wikia's network

Random Wiki