pandemonium_engine_minimal/doc/classes/InputMap.xml
2023-12-14 23:24:47 +01:00

102 lines
3.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputMap" inherits="Object" version="4.2">
<brief_description>
Singleton that manages [InputEventAction].
</brief_description>
<description>
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].
</description>
<tutorials>
<link>$DOCS_URL/tutorials/inputs/inputevent.html#inputmap</link>
</tutorials>
<methods>
<method name="action_add_event">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="event" type="InputEvent" />
<description>
</description>
</method>
<method name="action_erase_event">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="event" type="InputEvent" />
<description>
</description>
</method>
<method name="action_erase_events">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<description>
</description>
</method>
<method name="action_get_deadzone">
<return type="float" />
<argument index="0" name="action" type="StringName" />
<description>
</description>
</method>
<method name="action_has_event">
<return type="bool" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="event" type="InputEvent" />
<description>
</description>
</method>
<method name="action_set_deadzone">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="deadzone" type="float" />
<description>
</description>
</method>
<method name="add_action">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="deadzone" type="float" default="0.5" />
<description>
</description>
</method>
<method name="erase_action">
<return type="void" />
<argument index="0" name="action" type="StringName" />
<description>
</description>
</method>
<method name="event_is_action" qualifiers="const">
<return type="bool" />
<argument index="0" name="event" type="InputEvent" />
<argument index="1" name="action" type="StringName" />
<argument index="2" name="exact_match" type="bool" default="false" />
<description>
</description>
</method>
<method name="get_action_list">
<return type="Array" />
<argument index="0" name="action" type="StringName" />
<description>
</description>
</method>
<method name="get_actions">
<return type="Array" />
<description>
Returns an array of all actions in the [InputMap].
</description>
</method>
<method name="has_action" qualifiers="const">
<return type="bool" />
<argument index="0" name="action" type="StringName" />
<description>
</description>
</method>
<method name="load_from_globals">
<return type="void" />
<description>
Clears all [InputEventAction] in the [InputMap] and load it anew from [ProjectSettings].
</description>
</method>
</methods>
<constants>
</constants>
</class>