summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventAction.xml
blob: a2f4c9b9d3725d57d6b2ab616de4b0af7d3e9aa5 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?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 > Project Settings > 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>