godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/InputMap.xml

134 lines
4.2 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="InputMap" inherits="Object" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] InputEvent*
2017-10-15 22:07:13 +00:00
Singleton that manages [InputEventAction].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Manages all [InputEventAction] which can be created/modified from the project settings menu [b]Project &gt; Project Settings &gt; Input Map[/b] or in code with [method add_action] and [method action_add_event]. See [method Node._input].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 13:55:33 +00:00
<link>https://docs.godotengine.org/en/3.2/tutorials/inputs/inputevent.html#inputmap</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="action_add_event">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
<description>
[DOCS] InputEvent*
2017-10-15 22:07:13 +00:00
Adds an [InputEvent] to an action. This [InputEvent] will trigger the action.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="action_erase_event">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
<description>
[DOCS] InputEvent*
2017-10-15 22:07:13 +00:00
Removes an [InputEvent] from an action.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<method name="action_erase_events">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
[DOCS] Many class ref updates
2018-08-19 04:29:12 +00:00
Removes all events from an action.
Sync classref with current source
2018-05-12 07:38:00 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="action_has_event">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
<description>
[DOCS] Many class ref updates
2018-08-19 04:29:12 +00:00
Returns [code]true[/code] if the action has the given [InputEvent] associated with it.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<method name="action_set_deadzone">
<return type="void">
</return>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<argument index="0" name="action" type="String">
Sync classref with current source
2018-05-12 07:38:00 +00:00
</argument>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<argument index="1" name="deadzone" type="float">
Sync classref with current source
2018-05-12 07:38:00 +00:00
</argument>
<description>
[DOCS] Corrections and clarifications to classref
2020-01-10 18:46:41 +00:00
Sets a deadzone value for the action.
Sync classref with current source
2018-05-12 07:38:00 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="add_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<argument index="1" name="deadzone" type="float" default="0.5">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code].
Sync classref with current source
2018-05-12 07:38:00 +00:00
An [InputEvent] can then be added to this action with [method action_add_event].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="erase_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Removes an action from the [InputMap].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="event_is_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<argument index="1" name="action" type="String">
</argument>
<description>
doc: Fix wrong references found by new makerst.py Thanks @PJB3005
2019-01-07 09:02:04 +00:00
Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_action_list">
<return type="Array">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
[DOCS] InputEvent*
2017-10-15 22:07:13 +00:00
Returns an array of [InputEvent]s associated with a given action.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_actions">
<return type="Array">
</return>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Returns an array of all actions in the [InputMap].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Returns [code]true[/code] if the [InputMap] has a registered action with the given name.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="load_from_globals">
<return type="void">
</return>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Clears all [InputEventAction] in the [InputMap] and load it anew from [ProjectSettings].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>