godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added missing InputEvent documentation 

(cherry picked from commit 2046d7b87a)
This commit is contained in:
FlamyAT 2019-07-18 12:03:28 +02:00 committed by Rémi Verschelde
parent 81ac9c9afb
commit 4e07bab968
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/InputEvent.xml
View File

@ -17,6 +17,8 @@
<argument index="0" name="with_event" type="InputEvent"> <argument index="0" name="with_event" type="InputEvent">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="as_text" qualifiers="const"> <method name="as_text" qualifiers="const">
@ -32,6 +34,7 @@
<argument index="0" name="action" type="String"> <argument index="0" name="action" type="String">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="is_action" qualifiers="const"> <method name="is_action" qualifiers="const">
@ -88,6 +91,7 @@
<argument index="0" name="event" type="InputEvent"> <argument index="0" name="event" type="InputEvent">
</argument> </argument>
<description> <description>
Returns [code]true[/code] if the given input event is checking for the same key ([InputEventKey]), button ([InputEventJoypadButton]) or action ([InputEventAction]).
</description> </description>
</method> </method>
<method name="xformed_by" qualifiers="const"> <method name="xformed_by" qualifiers="const">
@ -98,6 +102,7 @@
<argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )"> <argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )">
</argument> </argument>
<description> <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> </description>
</method> </method>
</methods> </methods>