summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes/VisualScriptInputAction.xml
blob: 51c2eaf353973133bc78a5bfbd6654c183fd5384 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptInputAction" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<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>
	<members>
		<member name="action" type="StringName" setter="set_action_name" getter="get_action_name" default="&amp;&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>