virtualx-engine/doc/classes/InputEventAction.xml
Rémi Verschelde fc09e14366 classref: Sync with current source
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00

48 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Input event type for actions.
</brief_description>
<description>
Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu [code]Project &gt; Project Settings &gt; Input Map[/Code]. See [method Node._input].
</description>
<tutorials>
http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions
</tutorials>
<demos>
</demos>
<methods>
<method name="get_action" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="set_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="action" type="String" setter="set_action" getter="get_action">
The action's name. Actions are accessed via this [String].
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
If [code]true[/code] the action's state is pressed. If [code]false[/code] the action's state is released.
</member>
</members>
<constants>
</constants>
</class>