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

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2020-05-20 15:29:37 +02:00
parent 2ddbaeaf8c
commit 0b8cb945cf
7 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/DisplayServer.xml
View File

@ -592,6 +592,10 @@
</argument> </argument>
<argument index="2" name="max_length" type="int" default="-1"> <argument index="2" name="max_length" type="int" default="-1">
</argument> </argument>
<argument index="3" name="cursor_start" type="int" default="-1">
</argument>
<argument index="4" name="cursor_end" type="int" default="-1">
</argument>
<description> <description>
</description> </description>
</method> </method>

16
doc/classes/KinematicBody3D.xml
View File

@ -18,7 +18,7 @@
<argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis"> <argument index="0" name="axis" type="int" enum="PhysicsServer3D.BodyAxis">
</argument> </argument>
<description> <description>
Returns [code]true[/code] if the specified [code]axis[/code] is locked. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z]. Returns [code]true[/code] if the specified [code]axis[/code] is locked. See also [member axis_lock_motion_x], [member axis_lock_motion_y] and [member axis_lock_motion_z].
</description> </description>
</method> </method>
<method name="get_floor_normal" qualifiers="const"> <method name="get_floor_normal" qualifiers="const">
@ -145,7 +145,7 @@
<argument index="1" name="lock" type="bool"> <argument index="1" name="lock" type="bool">
</argument> </argument>
<description> <description>
Locks or unlocks the specified [code]axis[/code] depending on the value of [code]lock[/code]. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z]. Locks or unlocks the specified [code]axis[/code] depending on the value of [code]lock[/code]. See also [member axis_lock_motion_x], [member axis_lock_motion_y] and [member axis_lock_motion_z].
</description> </description>
</method> </method>
<method name="test_move"> <method name="test_move">
@ -163,18 +163,18 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin" default="0.001"> <member name="axis_lock_motion_x" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false">
If the body is at least this close to another body, this body will consider them to be colliding.
</member>
<member name="move_lock_x" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false">
Lock the body's X axis movement. Lock the body's X axis movement.
</member> </member>
<member name="move_lock_y" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false"> <member name="axis_lock_motion_y" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false">
Lock the body's Y axis movement. Lock the body's Y axis movement.
</member> </member>
<member name="move_lock_z" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false"> <member name="axis_lock_motion_z" type="bool" setter="set_axis_lock" getter="get_axis_lock" default="false">
Lock the body's Z axis movement. Lock the body's Z axis movement.
</member> </member>
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin" default="0.001">
If the body is at least this close to another body, this body will consider them to be colliding.
</member>
</members> </members>
<constants> <constants>
</constants> </constants>

2
doc/classes/OS.xml
View File

@ -518,7 +518,7 @@
<member name="low_processor_usage_mode_sleep_usec" type="int" setter="set_low_processor_usage_mode_sleep_usec" getter="get_low_processor_usage_mode_sleep_usec" default="6900"> <member name="low_processor_usage_mode_sleep_usec" type="int" setter="set_low_processor_usage_mode_sleep_usec" getter="get_low_processor_usage_mode_sleep_usec" default="6900">
The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage. The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
</member> </member>
<member name="tablet_driver" type="String" setter="set_current_tablet_driver" getter="get_current_tablet_driver" default="&quot;wintab&quot;"> <member name="tablet_driver" type="String" setter="set_current_tablet_driver" getter="get_current_tablet_driver" default="&quot;&quot;">
The current tablet drvier in use. The current tablet drvier in use.
</member> </member>
</members> </members>

2
doc/classes/PopupMenu.xml
View File

@ -591,7 +591,7 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="allow_search" type="bool" setter="set_allow_search" getter="get_allow_search" default="false"> <member name="allow_search" type="bool" setter="set_allow_search" getter="get_allow_search" default="true">
If [code]true[/code], allows to navigate [PopupMenu] with letter keys. If [code]true[/code], allows to navigate [PopupMenu] with letter keys.
</member> </member>
<member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection" default="true"> <member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection" default="true">

2
doc/classes/ProjectSettings.xml
View File

@ -450,7 +450,7 @@
<member name="display/window/size/width" type="int" setter="" getter="" default="1024"> <member name="display/window/size/width" type="int" setter="" getter="" default="1024">
Sets the game's main viewport width. On desktop platforms, this is the default window size. Stretch mode settings also use this as a reference when enabled. Sets the game's main viewport width. On desktop platforms, this is the default window size. Stretch mode settings also use this as a reference when enabled.
</member> </member>
<member name="display/window/tablet_driver" type="String" setter="" getter="" default="&quot;wintab&quot;"> <member name="display/window/tablet_driver" type="String" setter="" getter="" default="&quot;&quot;">
Specifies the tablet driver to use. If left empty, the default driver will be used. Specifies the tablet driver to use. If left empty, the default driver will be used.
</member> </member>
<member name="display/window/vsync/use_vsync" type="bool" setter="" getter="" default="true"> <member name="display/window/vsync/use_vsync" type="bool" setter="" getter="" default="true">

4
servers/display_server.cpp
View File

@ -213,7 +213,7 @@ bool DisplayServer::is_console_visible() const {
return false; return false;
} }
void DisplayServer::virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect, int p_max_legth, int p_cursor_start, int p_cursor_end) { void DisplayServer::virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect, int p_max_length, int p_cursor_start, int p_cursor_end) {
WARN_PRINT("Virtual keyboard not supported by this display server."); WARN_PRINT("Virtual keyboard not supported by this display server.");
} }
@ -439,7 +439,7 @@ void DisplayServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("console_set_visible", "console_visible"), &DisplayServer::console_set_visible); ClassDB::bind_method(D_METHOD("console_set_visible", "console_visible"), &DisplayServer::console_set_visible);
ClassDB::bind_method(D_METHOD("is_console_visible"), &DisplayServer::is_console_visible); ClassDB::bind_method(D_METHOD("is_console_visible"), &DisplayServer::is_console_visible);
ClassDB::bind_method(D_METHOD("virtual_keyboard_show", "existing_text", "position", "max_length"), &DisplayServer::virtual_keyboard_show, DEFVAL(Rect2i()), DEFVAL(-1)); ClassDB::bind_method(D_METHOD("virtual_keyboard_show", "existing_text", "position", "max_length", "cursor_start", "cursor_end"), &DisplayServer::virtual_keyboard_show, DEFVAL(Rect2i()), DEFVAL(-1), DEFVAL(-1), DEFVAL(-1));
ClassDB::bind_method(D_METHOD("virtual_keyboard_hide"), &DisplayServer::virtual_keyboard_hide); ClassDB::bind_method(D_METHOD("virtual_keyboard_hide"), &DisplayServer::virtual_keyboard_hide);
ClassDB::bind_method(D_METHOD("virtual_keyboard_get_height"), &DisplayServer::virtual_keyboard_get_height); ClassDB::bind_method(D_METHOD("virtual_keyboard_get_height"), &DisplayServer::virtual_keyboard_get_height);

2
servers/display_server.h
View File

@ -280,7 +280,7 @@ public:
virtual void console_set_visible(bool p_enabled); virtual void console_set_visible(bool p_enabled);
virtual bool is_console_visible() const; virtual bool is_console_visible() const;
virtual void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), int p_max_legth = -1, int p_cursor_start = -1, int p_cursor_end = -1); virtual void virtual_keyboard_show(const String &p_existing_text, const Rect2 &p_screen_rect = Rect2(), int p_max_length = -1, int p_cursor_start = -1, int p_cursor_end = -1);
virtual void virtual_keyboard_hide(); virtual void virtual_keyboard_hide();
// returns height of the currently shown virtual keyboard (0 if keyboard is hidden) // returns height of the currently shown virtual keyboard (0 if keyboard is hidden)