API:GetButtonName

UI Lua API · Game functions
Version: WAR 1.4.8

Returns the display name of a key or button on an input device.

name = GetButtonName(deviceId, buttonId)

Arguments

deviceId

number – Input device, for example SystemData.InputDevice.KEYBOARD.

buttonId

number – Button id on that device, as returned in the buttons array of GetBindingsForAction. easystem_utils/source/keyutils.lua lists some keyboard ids, for example 42 for left Shift.

Returns

name

wstring – Name of the button.

Details

• Both numbers are converted to integers.
• The client first looks in its own table of button names. If the button is not there, it asks the input system for a name.
• The name is localised. easystem_utils/source/keyutils.lua notes that its short-name lookup table must be keyed with GetButtonName results for this reason.

Errors

None.

Example

From easystem_utils/source/keyutils.lua:

local buttonName = GetButtonName( deviceId, buttonId )

Building a lookup table of localised modifier names, from the same file:

[GetButtonName(SystemData.InputDevice.KEYBOARD, LSHIFT)]      = StringTables.ShortKeyNames.SHORTKEY_LEFT_SHIFT,
[GetButtonName(SystemData.InputDevice.KEYBOARD, LCTRL)]       = StringTables.ShortKeyNames.SHORTKEY_LEFT_CONTROL,

See also

• GetBindingsForAction
• GetActionsForButtonCombination