WoW:API GetBindingText - Revision history

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

2023-08-15T04:45:47Z

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

← Older revision

Revision as of 04:45, 15 August 2023

WoWWiki>Charibot: catfix, Replaced: {{framexml →
{{framexml

2008-07-15T00:43:07Z

catfix, Replaced: {{framexml → <br>{{framexml

← Older revision		Revision as of 00:43, 15 July 2008
Line 1:		Line 1:
	{{framexmlfunc\|FrameXML/UIParent.lua}} __NOTOC__		<br>{{framexmlfunc\|FrameXML/UIParent.lua}} __NOTOC__

WoWWiki>WoWWiki-Flick at 23:19, 13 March 2007

2007-03-13T23:19:42Z

← Older revision		Revision as of 23:19, 13 March 2007
Line 2:		Line 2:


	text = GetBindingText(key,prefix)		text = GetBindingText(key,prefix,abbreviate)

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


Line 10:		Line 10:
	=== Arguments ===		=== Arguments ===

	:(String key, String prefix)		:(String key, String prefix, [Boolean abbreviate])

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

	=== Returns ===		=== Returns ===

	:;value : String - The ~~(localized?)~~ value of the global variable ~~composed of~~ 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.		:;value : 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 ==		== Example ==

WoWWiki>Mikk at 14:14, 5 September 2006

2006-09-05T14:14:59Z

← Older revision		Revision as of 14:14, 5 September 2006
Line 1:		Line 1:
	~~<center>'''~~GetBindingText~~'''</center>~~		{{framexmlfunc\|FrameXML/UIParent.lua}} __NOTOC__


			text = GetBindingText(key,prefix)

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

	~~----~~
	~~;''~~Arguments''		== Parameters ==
			=== Arguments ===

	:(String key, String prefix)		:(String key, String prefix)

	:;key : The name of the key (e.g. UP, SHIFT-PAGEDOWN)		:;key : String - The name of the key (e.g. "UP", "SHIFT-PAGEDOWN")
	:;prefix : The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_".		:;prefix : String - The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_".

	~~----~~		=== Returns ===
	~~;''~~Returns''

	:value		:;value : String - The (localized?) value of the global variable composed of 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.

	:;value : (string) The (localized?) value of the global variable composed of 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.		== Example ==

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

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

WoWWiki>Anticrash at 15:06, 4 January 2006

2006-01-04T15:06:59Z

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

WoWWiki>Aalnydara: details for GetBindingText

2005-11-27T19:12:00Z

details for GetBindingText

New page

<center>'''GetBindingText'''</center>

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

----
;''Arguments''

:(String key, String prefix)

:;key : The name of the key (e.g. UP, SHIFT-PAGEDOWN)
:;prefix : The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_".

----
;''Returns''

:value

:;value : (string) The (localized?) value of the global variable composed of 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.

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

----
{{Template:WoW API}}
[[Category:API Functions|GetBindingText]]
[[Category:API Key Binding Functions|GetBindingText]]