Wowpedia

We have moved to Warcraft Wiki. Click here for information and the new URL.

READ MORE

Wowpedia
Register
Advertisement

Returns the name and keys for a binding by index.

command, category, key1, key2, ... = GetBinding(index [, alwaysIncludeGamepad])

Arguments[]

index
number - index of the binding to query, from 1 to GetNumBindings().
alwaysIncludeGamepad
boolean? - If gamepad support is disabled, then gamepad bindings are only returned if this is true.

Returns[]

command
string - Command this binding will perform (e.g. MOVEFORWARD). For well-behaved bindings, a human-readable description is stored in the _G["BINDING_NAME_" .. command] global variable.
category
string - Category this binding was declared in (e.g. BINDING_HEADER_MOVEMENT). For well-behaved bindings, a human-readable title is stored in the _G[category] global variable.
key1, key2, ...
string? - Key combination this binding is bound to (e.g. W, CTRL-F). key1 and key2 can be nil if there is nothing bound to the command.

Details[]

  • Even though the default Key Binding window only shows up to two bindings for each command, it is actually possible to bind more using SetBinding, and this function will return all of the keys bound to the given command, not just the first two.

Example[]

local function dumpBinding(command, category, ...)
	local cmdName = _G["BINDING_NAME_" .. command]
	local catName = _G[category]
	print(("%s > %s (%s) is bound to:"):format(catName or "?", cmdName or "?", command), strjoin(", ", ...))
end

dumpBinding(GetBinding(5)) -- "Movement Keys > Turn Right (TURNRIGHT) is bound to: D, RIGHT"

See also[]

Advertisement