Home › Engine executable › Input actions (hotkeys)

Input actions (hotkeys)

Hotkeys are data: the actions, their categories and contexts and the default key or button for each live in the Configuration database (tables InputActions, InputCategories, InputContexts, InputActionDefaultGestures, InputKeyData), filled by InputConfiguration.xml and by the Config XML of expansions and scenarios. The exe loads them with CivTech::Input::Manager::ReloadInputActions (0x96c950), which joins the tables with this query (Verified, string in the exe): SELECT ActionId, InputActions.Name AS 'Name', Description, InputCategories.Name AS 'Category', InputContexts.Value AS 'Context', LayoutType FROM InputActions INNER JOIN InputCategories ... INNER JOIN InputContexts ... ORDER BY InputActions.ActionId, and the default gestures with SELECT "Index", GestureType, GestureData FROM InputActionDefaultGestures WHERE ActionId = ?. Scripts look an action up with Input.GetActionId("<ActionId>") (68 calls in the shipped scripts; see the Input table). This page lists what the installed game defines (76 actions, 7 categories, 16 contexts, 191 key records) and which action names the exe also registers in code. A new hotkey needs an InputActions row (action id, text keys, category, context, layout type) and a default gesture row; the localisation keys (LOC_OPTIONS_HOTKEY_...) are text keys, not text.

Layouts and gestures. Actions are for the PC layout (59, gesture type KBMouse) or the Console layout (17, gesture type Controller). Context values are the numbers in the contexts table below; the query returns the value, so scripts and code compare numbers.

Code-registered actions. App::InputAction::Manager::SetupActions (0x3b7f0) names 18 actions in code: CameraPan, FocusNext, FocusPrev, InGameMenu, LeftClickCursor, MenuDown, MenuLeft, MenuRight, MenuUp, MoveCursor, NavigateMap, NextAction, Notifications, Select, SelectCenterPlot, ToggleTooltips, ZoomIn, ZoomOut. 16 of them are rows of the table; not in the table (cursor actions that code probably handles by itself, inferred from the names): LeftClickCursor, MoveCursor.

Script references without a row. The shipped scripts ask for Accept, AcceptAlt, AutomationTogglePause, StartGame, StartGameAlt, TutorialContinue, TutorialContinueAlt, TutorialShowMore; none of them has an InputActions row (the tutorial and popup rows are commented out in InputConfiguration.xml), so for those Input.GetActionId has nothing to return.

Categories

Contexts

Actions (76)

Key records (191)

InputKeyData maps a key id to the text key shown in the options screen and the icon name. Types: Controller (55), KBMouse (136).