Locale.GetHotKeyDescription (Civ5 API)

This page is a part of the Lua and UI Reference (Civ5).

This function is a member of Locale. This is a static method, invoke it with a dot.

Returns a localized description for a hotkey

Usage

unknown Locale.GetHotKeyDescription(string key, bool ctrl = nil, bool alt = nil, bool shift = nil)

Returned Value

Returns a localized string for the hot key.

Parameters

key:	The name of the hot key.
ctrl:	Whether the control key is pressed.
alt:	Whether the alt key is pressed.
shift:	Whether the shift key is pressed.

Examples

local hotKeyDesc = Locale.GetHotKeyDescription("KB_Y", false, true, true);

Source code samples

MiniMapPanel.lua

UI/InGame/WorldView/MiniMapPanel.lua

0422	local keyDesc = Locale.GetHotKeyDescription(hotKey, controlInfo.CtrlDown, controlInfo.AltDown, controlInfo.ShiftDown);

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.