diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2020-03-09 10:12:53 +0100 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-03-09 10:13:45 +0100 |
commit | 471271b727fd1dcc716a10f34e615ce61ca6d16e (patch) | |
tree | 765f22ee8c709476a5c0e11165c38a5e7796f27b | |
parent | e629b4bc8af9221c2a8088660e13e91394f02504 (diff) |
doc: Sync classref with current source
-rw-r--r-- | doc/classes/InputEventKey.xml | 6 | ||||
-rw-r--r-- | doc/classes/OS.xml | 32 | ||||
-rw-r--r-- | doc/classes/Rect2.xml | 2 | ||||
-rw-r--r-- | doc/classes/Semaphore.xml | 12 |
4 files changed, 26 insertions, 26 deletions
diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 42ac7e58d9..c8d0769b90 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -31,9 +31,6 @@ <member name="echo" type="bool" setter="set_echo" getter="is_echo" default="false"> If [code]true[/code], the key was already pressed before this event. It means the user is holding the key down. </member> - <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> - If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. - </member> <member name="keycode" type="int" setter="set_keycode" getter="get_keycode" default="0"> The key keycode, which corresponds to one of the [enum KeyList] constants. Represent key in the current keyboard layout. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. @@ -42,6 +39,9 @@ Key physical keycode, which corresponds to one of the [enum KeyList] constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> + If [code]true[/code], the key's state is pressed. If [code]false[/code], the key's state is released. + </member> <member name="unicode" type="int" setter="set_unicode" getter="get_unicode" default="0"> The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information. </member> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 6d950a4175..d43c395433 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -242,6 +242,16 @@ [b]Note:[/b] This method is implemented on macOS. </description> </method> + <method name="get_keycode_string" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <description> + Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). + See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. + </description> + </method> <method name="get_latin_keyboard_variant" qualifiers="const"> <return type="String"> </return> @@ -295,16 +305,6 @@ Returns the window size including decorations like window borders. </description> </method> - <method name="get_keycode_string" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="code" type="int"> - </argument> - <description> - Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). - See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. - </description> - </method> <method name="get_screen_count" qualifiers="const"> <return type="int"> </return> @@ -588,20 +588,20 @@ To check whether the Godot binary used to run the project is an export template (debug or release), use [code]OS.has_feature("standalone")[/code] instead. </description> </method> - <method name="is_ok_left_and_cancel_right" qualifiers="const"> + <method name="is_keycode_unicode" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="code" type="int"> + </argument> <description> - Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. + Returns [code]true[/code] if the input keycode corresponds to a Unicode character. </description> </method> - <method name="is_keycode_unicode" qualifiers="const"> + <method name="is_ok_left_and_cancel_right" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="code" type="int"> - </argument> <description> - Returns [code]true[/code] if the input keycode corresponds to a Unicode character. + Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. </description> </method> <method name="is_stdout_verbose" qualifiers="const"> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index dbf461cdf1..5bc55c9ce3 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -143,7 +143,7 @@ </return> <argument index="0" name="b" type="Rect2"> </argument> - <argument index="1" name="include_borders" type="bool" default="false"> + <argument index="1" name="include_borders" type="bool" default="False"> </argument> <description> Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 19719eea93..c9745acfcd 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -17,18 +17,18 @@ Lowers the [Semaphore], allowing one more thread in. </description> </method> - <method name="wait"> - <return type="void"> + <method name="try_wait"> + <return type="int" enum="Error"> </return> <description> - Waits for the [Semaphore], if its value is zero, blocks until non-zero. + Like [method wait], but won't block, so if the value is zero, fails immediately and returns [constant ERR_BUSY]. If non-zero, it returns [constant OK] to report success. </description> </method> - <method name="try_wait"> - <return type="int" enum="Error"> + <method name="wait"> + <return type="void"> </return> <description> - Like [method wait], but won't block, so if the value is zero, fails immediately and returns [constant ERR_BUSY]. If non-zero, it returns [constant OK] to report success. + Waits for the [Semaphore], if its value is zero, blocks until non-zero. </description> </method> </methods> |