virtualx-engine/modules/visual_script/doc_classes/VisualScriptInputAction.xml
2021-11-05 16:10:17 +01:00

35 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptInputAction" inherits="VisualScriptNode" version="3.5">
<brief_description>
A Visual Script node returning a state of an action.
</brief_description>
<description>
[VisualScriptInputAction] can be used to check if an action is pressed or released.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="action" type="String" setter="set_action_name" getter="get_action_name" default="&quot;&quot;">
Name of the action.
</member>
<member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0">
State of the action to check. See [enum Mode] for options.
</member>
</members>
<constants>
<constant name="MODE_PRESSED" value="0" enum="Mode">
[code]True[/code] if action is pressed.
</constant>
<constant name="MODE_RELEASED" value="1" enum="Mode">
[code]True[/code] if action is released (i.e. not pressed).
</constant>
<constant name="MODE_JUST_PRESSED" value="2" enum="Mode">
[code]True[/code] on the frame the action was pressed.
</constant>
<constant name="MODE_JUST_RELEASED" value="3" enum="Mode">
[code]True[/code] on the frame the action was released.
</constant>
</constants>
</class>