Prechádzať zdrojové kódy

Merge pull request #11107 from hpvb/document-inputevent

Correct InputEvent documentation
Poommetee Ketson 8 rokov pred
rodič
commit
adc8215e9c
1 zmenil súbory, kde vykonal 10 pridanie a 5 odobranie
  1. 10 5
      doc/base/classes.xml

+ 10 - 5
doc/base/classes.xml

@@ -23274,6 +23274,7 @@
 </class>
 <class name="InputEvent" inherits="Resource" category="Core">
 	<brief_description>
+		Generic input event
 	</brief_description>
 	<description>
 	</description>
@@ -23284,24 +23285,28 @@
 			<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">
@@ -23310,7 +23315,7 @@
 			<argument index="0" name="action" type="String">
 			</argument>
 			<description>
-				Return if this input event matches a pre-defined action, no matter the type.
+				Returns true if this input event matches a pre-defined action, no matter the type.
 			</description>
 		</method>
 		<method name="is_action_pressed" qualifiers="const">
@@ -23319,7 +23324,7 @@
 			<argument index="0" name="action" type="String">
 			</argument>
 			<description>
-				Return whether 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.
+				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">
@@ -23328,7 +23333,7 @@
 			<argument index="0" name="action" type="String">
 			</argument>
 			<description>
-				Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
+				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">
@@ -23341,14 +23346,14 @@
 			<return type="bool">
 			</return>
 			<description>
-				Return if this input event is an echo event (only for events of type KEY, it will return false for other types).
+				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>
-				Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
+				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">