summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventAction.xml
blob: 9df7bbca74a5eb18c6daedc90c832d91ec77e397 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.2">
	<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>
		<link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#actions</link>
	</tutorials>
	<methods>
	</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>
		<member name="strength" type="float" setter="set_strength" getter="get_strength">
			The action's strength between 0 and 1. This value is consired as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed.
		</member>
	</members>
	<constants>
	</constants>
</class>