summaryrefslogtreecommitdiff
path: root/doc/classes/InputEvent.xml
blob: 392ee25ad6db767204783c617435838dc7258ab5 (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEvent" inherits="Resource" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Generic input event
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="action_match" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="event" type="InputEvent">
			</argument>
			<description>
				Returns true if this input event matches the event passed.
			</description>
		</method>
		<method name="as_text" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns a [String] representation of the event.
			</description>
		</method>
		<method name="get_device" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the id of the device that generated the event.
			</description>
		</method>
		<method name="get_id" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the id of the event.
			</description>
		</method>
		<method name="is_action" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="action" type="String">
			</argument>
			<description>
				Returns true if this input event matches a pre-defined action, no matter the type.
			</description>
		</method>
		<method name="is_action_pressed" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="action" type="String">
			</argument>
			<description>
				Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
			</description>
		</method>
		<method name="is_action_released" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="action" type="String">
			</argument>
			<description>
				Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
			</description>
		</method>
		<method name="is_action_type" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="is_echo" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types).
			</description>
		</method>
		<method name="is_pressed" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
			</description>
		</method>
		<method name="set_device">
			<return type="void">
			</return>
			<argument index="0" name="device" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_id">
			<return type="void">
			</return>
			<argument index="0" name="id" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="shortcut_match" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="event" type="InputEvent">
			</argument>
			<description>
			</description>
		</method>
		<method name="xformed_by" qualifiers="const">
			<return type="InputEvent">
			</return>
			<argument index="0" name="xform" type="Transform2D">
			</argument>
			<argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="device" type="int" setter="set_device" getter="get_device">
		</member>
	</members>
	<constants>
	</constants>
</class>