|
enum | KeymapType { kKeymapTypeGlobal,
kKeymapTypeGui,
kKeymapTypeGame
} |
|
enum | KeymapMatch { kKeymapMatchNone,
kKeymapMatchPartial,
kKeymapMatchExact
} |
|
typedef Array< Action * > | ActionArray |
|
◆ registerMapping()
◆ unregisterMapping()
void Common::Keymap::unregisterMapping |
( |
Action * |
action | ) |
|
Unregisters a HardwareInput from the given Action (if one is mapped)
- Parameters
-
- See also
- Action::mapKey
◆ resetMapping()
void Common::Keymap::resetMapping |
( |
Action * |
action | ) |
|
Reset an action's mapping to its defaults
- Parameters
-
◆ getActionMapping()
Find the hardware input an action is mapped to, if any
◆ getMappedActions()
KeymapMatch Common::Keymap::getMappedActions |
( |
const Event & |
event, |
|
|
ActionArray & |
actions |
|
) |
| const |
Find the Actions that a hardware input is mapped to
- Parameters
-
hardwareInput | the input that is mapped to the required Action |
actions | an array containing pointers to the actions |
- Returns
- the matching status for the retieved actions
◆ addAction()
void Common::Keymap::addAction |
( |
Action * |
action | ) |
|
Adds a new Action to this Map
Takes ownership of the action.
- Parameters
-
◆ getActions()
const ActionArray& Common::Keymap::getActions |
( |
| ) |
const |
|
inline |
Get the list of all the Actions contained in this Keymap
◆ getActionDefaultMappings()
Get the default input mappings for an action.
Backend-specific mappings replace the default mappings specified when creating the keymap.
◆ loadMappings()
void Common::Keymap::loadMappings |
( |
| ) |
|
Load this keymap's mappings from the config manager.
- Parameters
-
hwInputs | the set to retrieve hardware input pointers from |
◆ saveMappings()
void Common::Keymap::saveMappings |
( |
| ) |
|
Save this keymap's mappings to the config manager
- Note
- Changes are not flushed to disk, to do so call ConfMan.flushToDisk()
◆ isEnabled()
bool Common::Keymap::isEnabled |
( |
| ) |
const |
|
inline |
Defines if the keymap is considered when mapping events
◆ arrayOf()
Helper to return an array with a single keymap element
The documentation for this class was generated from the following file: