2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-04-26 11:14:51 +00:00
<class name= "InputEvent" inherits= "Resource" version= "3.4" >
2017-09-12 20:42:36 +00:00
<brief_description >
2020-01-23 10:14:14 +00:00
Generic input event.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-10-15 22:07:13 +00:00
Base class of all sort of input event. See [method Node._input].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2021-08-12 14:58:38 +00:00
<link title= "InputEvent" > https://docs.godotengine.org/en/3.4/tutorials/inputs/inputevent.html</link>
<link title= "Viewport and canvas transforms" > https://docs.godotengine.org/en/3.4/tutorials/2d/2d_transforms.html</link>
2020-10-01 08:34:47 +00:00
<link title= "2D Dodge The Creeps Demo" > https://godotengine.org/asset-library/asset/515</link>
<link title= "3D Voxel Demo" > https://godotengine.org/asset-library/asset/676</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
2019-03-07 09:54:42 +00:00
<method name= "accumulate" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "with_event" type= "InputEvent" />
2019-03-07 09:54:42 +00:00
<description >
2019-07-18 10:03:28 +00:00
Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]).
The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical.
2019-03-07 09:54:42 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "as_text" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "String" />
2017-09-12 20:42:36 +00:00
<description >
2018-05-12 07:38:00 +00:00
Returns a [String] representation of the event.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "get_action_strength" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
<argument index= "0" name= "action" type= "String" />
<argument index= "1" name= "exact_match" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2019-07-18 10:03:28 +00:00
Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion].
Allow checking for exact matches with Action events.
Added additional param to action related methods to test for exactness.
If "p_exact_match" is true, then the action will only be "matched" if the provided input event *exactly* matches with the action event.
Before:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* Is Action Pressed = True
Now:
You can still do the above, however you can optionally check that the input is exactly what the action event is:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* p_exact_match = True
* Is Action Pressed = False
* If the Input Event was only KEY_S, then the result would be true.
Usage:
```gdscript
Input.is_action_pressed(action_name: String, exact_match: bool)
Input.is_action_pressed("my_action", true)
InputMap.event_is_action(p_event, "my_action", true)
func _input(event: InputEvent):
event.is_action_pressed("my_action", false, true) # false = "allow_echo", true = "exact_match"
event.is_action("my_action", true)
```
Co-authored-by: Eric M <itsjusteza@gmail.com>
2020-12-13 14:22:42 +00:00
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_action" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "action" type= "String" />
<argument index= "1" name= "exact_match" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2017-10-15 22:07:13 +00:00
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
Allow checking for exact matches with Action events.
Added additional param to action related methods to test for exactness.
If "p_exact_match" is true, then the action will only be "matched" if the provided input event *exactly* matches with the action event.
Before:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* Is Action Pressed = True
Now:
You can still do the above, however you can optionally check that the input is exactly what the action event is:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* p_exact_match = True
* Is Action Pressed = False
* If the Input Event was only KEY_S, then the result would be true.
Usage:
```gdscript
Input.is_action_pressed(action_name: String, exact_match: bool)
Input.is_action_pressed("my_action", true)
InputMap.event_is_action(p_event, "my_action", true)
func _input(event: InputEvent):
event.is_action_pressed("my_action", false, true) # false = "allow_echo", true = "exact_match"
event.is_action("my_action", true)
```
Co-authored-by: Eric M <itsjusteza@gmail.com>
2020-12-13 14:22:42 +00:00
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_action_pressed" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "action" type= "String" />
<argument index= "1" name= "allow_echo" type= "bool" default= "false" />
<argument index= "2" name= "exact_match" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2019-11-08 15:00:01 +00:00
Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
Allow checking for exact matches with Action events.
Added additional param to action related methods to test for exactness.
If "p_exact_match" is true, then the action will only be "matched" if the provided input event *exactly* matches with the action event.
Before:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* Is Action Pressed = True
Now:
You can still do the above, however you can optionally check that the input is exactly what the action event is:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* p_exact_match = True
* Is Action Pressed = False
* If the Input Event was only KEY_S, then the result would be true.
Usage:
```gdscript
Input.is_action_pressed(action_name: String, exact_match: bool)
Input.is_action_pressed("my_action", true)
InputMap.event_is_action(p_event, "my_action", true)
func _input(event: InputEvent):
event.is_action_pressed("my_action", false, true) # false = "allow_echo", true = "exact_match"
event.is_action("my_action", true)
```
Co-authored-by: Eric M <itsjusteza@gmail.com>
2020-12-13 14:22:42 +00:00
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
2022-01-04 21:11:49 +00:00
[b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_action_released" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "action" type= "String" />
<argument index= "1" name= "exact_match" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-27 10:34:26 +00:00
Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
Allow checking for exact matches with Action events.
Added additional param to action related methods to test for exactness.
If "p_exact_match" is true, then the action will only be "matched" if the provided input event *exactly* matches with the action event.
Before:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* Is Action Pressed = True
Now:
You can still do the above, however you can optionally check that the input is exactly what the action event is:
* Action Event = KEY_S
* Input Event = KEY_CONTROL + KEY_S
* p_exact_match = True
* Is Action Pressed = False
* If the Input Event was only KEY_S, then the result would be true.
Usage:
```gdscript
Input.is_action_pressed(action_name: String, exact_match: bool)
Input.is_action_pressed("my_action", true)
InputMap.event_is_action(p_event, "my_action", true)
func _input(event: InputEvent):
event.is_action_pressed("my_action", false, true) # false = "allow_echo", true = "exact_match"
event.is_action("my_action", true)
```
Co-authored-by: Eric M <itsjusteza@gmail.com>
2020-12-13 14:22:42 +00:00
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_action_type" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-27 10:34:26 +00:00
Returns [code]true[/code] if this input event's type is one that can be assigned to an input action.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_echo" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-27 10:34:26 +00:00
Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "is_pressed" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2017-09-12 20:42:36 +00:00
<description >
2019-06-27 10:34:26 +00:00
Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
2022-01-04 21:11:49 +00:00
[b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "shortcut_match" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
<argument index= "0" name= "event" type= "InputEvent" />
2021-09-16 05:09:40 +00:00
<argument index= "1" name= "exact_match" type= "bool" default= "true" />
2017-09-12 20:42:36 +00:00
<description >
2021-09-16 05:09:40 +00:00
Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events.
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "xformed_by" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "InputEvent" />
<argument index= "0" name= "xform" type= "Transform2D" />
<argument index= "1" name= "local_ofs" type= "Vector2" default= "Vector2( 0, 0 )" />
2017-09-12 20:42:36 +00:00
<description >
2019-07-18 10:03:28 +00:00
Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture].
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "device" type= "int" setter= "set_device" getter= "get_device" default= "0" >
2017-10-15 22:07:13 +00:00
The event's device ID.
2019-12-30 14:28:24 +00:00
[b]Note:[/b] This device ID will always be [code]-1[/code] for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
</constants>
</class>
