summaryrefslogtreecommitdiff
path: root/doc/classes/Shortcut.xml
blob: d9f7f98888d7d2eaec5fe0b037ce389e6e732d47 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Shortcut" inherits="Resource" version="4.0">
	<brief_description>
		A shortcut for binding input.
	</brief_description>
	<description>
		A shortcut for binding input.
		Shortcuts are commonly used for interacting with a [Control] element from an [InputEvent] (also known as hotkeys).
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_as_text" qualifiers="const">
			<return type="String" />
			<description>
				Returns the shortcut's [InputEvent] as a [String].
			</description>
		</method>
		<method name="has_valid_event" qualifiers="const">
			<return type="bool" />
			<description>
				Returns whether the shortcut has a valid [member event] assigned to it.
			</description>
		</method>
		<method name="matches_event" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="event" type="InputEvent" />
			<description>
				Returns whether the shortcut's [member event] matches [code]event[/code].
			</description>
		</method>
	</methods>
	<members>
		<member name="event" type="InputEvent" setter="set_event" getter="get_event">
			The shortcut's [InputEvent].
			Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction].
		</member>
	</members>
	<constants>
	</constants>
</class>