| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the InputMap.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_InputMap:
- InputMap
- ========
- **Inherits:** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Singleton that manages :ref:`InputEventAction<class_inputeventaction>`.
- Member Functions
- ----------------
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- Description
- -----------
- Manages all :ref:`InputEventAction<class_inputeventaction>` which can be created/modified from the project settings menu ``Project > Project Settings > Input Map`` or in code with :ref:`add_action<class_InputMap_add_action>` and :ref:`action_add_event<class_InputMap_action_add_event>`. See :ref:`Node._input<class_Node__input>`.
- Member Function Description
- ---------------------------
- .. _class_InputMap_action_add_event:
- - void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
- Adds an :ref:`InputEvent<class_inputevent>` to an action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
- .. _class_InputMap_action_erase_event:
- - void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
- Removes an :ref:`InputEvent<class_inputevent>` from an action.
- .. _class_InputMap_action_has_event:
- - :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
- Returns true if an action has an :ref:`InputEvent<class_inputevent>` associated with it.
- .. _class_InputMap_add_action:
- - void **add_action** **(** :ref:`String<class_string>` action **)**
- Adds an (empty) action to the ``InputMap``. An :ref:`InputEvent<class_inputevent>` can then be added to this action with :ref:`action_add_event<class_InputMap_action_add_event>`.
- .. _class_InputMap_erase_action:
- - void **erase_action** **(** :ref:`String<class_string>` action **)**
- Removes an action from the ``InputMap``.
- .. _class_InputMap_event_is_action:
- - :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
- Returns true if the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_inputevent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
- .. _class_InputMap_get_action_list:
- - :ref:`Array<class_array>` **get_action_list** **(** :ref:`String<class_string>` action **)**
- Returns an array of :ref:`InputEvent<class_inputevent>`\ s associated with a given action.
- .. _class_InputMap_get_actions:
- - :ref:`Array<class_array>` **get_actions** **(** **)**
- Returns an array of all actions in the ``InputMap``.
- .. _class_InputMap_has_action:
- - :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_string>` action **)** const
- Returns ``true`` if the ``InputMap`` has a registered action with the given name.
- .. _class_InputMap_load_from_globals:
- - void **load_from_globals** **(** **)**
- Clears all :ref:`InputEventAction<class_inputeventaction>` in the ``InputMap`` and load it anew from :ref:`ProjectSettings<class_projectsettings>`.
|
