diff options
Diffstat (limited to 'doc/classes/InputEvent.xml')
| -rw-r--r-- | doc/classes/InputEvent.xml | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 447c7251b8..d412ce09e2 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -10,8 +10,6 @@ <link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> <link>https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> </tutorials> - <demos> - </demos> <methods> <method name="accumulate"> <return type="bool"> @@ -19,6 +17,8 @@ <argument index="0" name="with_event" type="InputEvent"> </argument> <description> + 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. </description> </method> <method name="as_text" qualifiers="const"> @@ -34,6 +34,7 @@ <argument index="0" name="action" type="String"> </argument> <description> + 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]. </description> </method> <method name="is_action" qualifiers="const"> @@ -50,8 +51,10 @@ </return> <argument index="0" name="action" type="String"> </argument> + <argument index="1" name="allow_echo" type="bool" default="false"> + </argument> <description> - Returns [code]true[/code] if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. + 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]. </description> </method> <method name="is_action_released" qualifiers="const"> @@ -60,28 +63,28 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. </description> </method> <method name="is_action_type" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if this input event's type is one of the [InputEvent] constants. + Returns [code]true[/code] if this input event's type is one that can be assigned to an input action. </description> </method> <method name="is_echo" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if this input event is an echo event (only for events of type KEY). + Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]). </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. + Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. </description> </method> <method name="shortcut_match" qualifiers="const"> @@ -90,6 +93,7 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Returns [code]true[/code] if the given input event is checking for the same key ([InputEventKey]), button ([InputEventJoypadButton]) or action ([InputEventAction]). </description> </method> <method name="xformed_by" qualifiers="const"> @@ -100,11 +104,12 @@ <argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> + 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]. </description> </method> </methods> <members> - <member name="device" type="int" setter="set_device" getter="get_device"> + <member name="device" type="int" setter="set_device" getter="get_device" default="0"> The event's device ID. </member> </members> |