Browse Source

Merge pull request #42672 from akien-mga/doc-classref-sync

doc: Sync classref with current source
Rémi Verschelde 4 years ago
parent
commit
c35005ba25

+ 8 - 8
doc/classes/Animation.xml

@@ -681,26 +681,26 @@
 				Returns the update mode of a value track.
 				Returns the update mode of a value track.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="value_track_set_update_mode">
-			<return type="void">
+		<method name="value_track_interpolate" qualifiers="const">
+			<return type="Variant">
 			</return>
 			</return>
 			<argument index="0" name="track_idx" type="int">
 			<argument index="0" name="track_idx" type="int">
 			</argument>
 			</argument>
-			<argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
+			<argument index="1" name="time_sec" type="float">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Sets the update mode (see [enum UpdateMode]) of a value track.
+				Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track.
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="value_track_interpolate" qualifiers="const">
-			<return type="float">
+		<method name="value_track_set_update_mode">
+			<return type="void">
 			</return>
 			</return>
 			<argument index="0" name="track_idx" type="int">
 			<argument index="0" name="track_idx" type="int">
 			</argument>
 			</argument>
-			<argument index="1" name="time_sec" type="float">
+			<argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
 			</argument>
 			</argument>
 			<description>
 			<description>
-				Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track.
+				Sets the update mode (see [enum UpdateMode]) of a value track.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>

+ 0 - 1
doc/classes/ArrayMesh.xml

@@ -69,7 +69,6 @@
 			<argument index="2" name="blend_shapes" type="Array" default="[  ]">
 			<argument index="2" name="blend_shapes" type="Array" default="[  ]">
 			</argument>
 			</argument>
 			<argument index="3" name="lods" type="Dictionary" default="{
 			<argument index="3" name="lods" type="Dictionary" default="{
-
 }">
 }">
 			</argument>
 			</argument>
 			<argument index="4" name="compress_flags" type="int" default="31744">
 			<argument index="4" name="compress_flags" type="int" default="31744">

+ 0 - 2
doc/classes/Basis.xml

@@ -111,8 +111,6 @@
 			</return>
 			</return>
 			<argument index="0" name="b" type="Basis">
 			<argument index="0" name="b" type="Basis">
 			</argument>
 			</argument>
-			<argument index="1" name="epsilon" type="float" default="1e-05">
-			</argument>
 			<description>
 			<description>
 				Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 				Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
 			</description>
 			</description>

+ 3 - 3
doc/classes/CanvasItem.xml

@@ -607,9 +607,6 @@
 		<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false">
 		<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled" default="false">
 			If [code]true[/code], the object draws behind its parent.
 			If [code]true[/code], the object draws behind its parent.
 		</member>
 		</member>
-		<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level">
-			If [code]true[/code], the node will not inherit its transform from parent [CanvasItem]s.
-		</member>
 		<member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top">
 		<member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top">
 			If [code]true[/code], the object draws on top of its parent.
 			If [code]true[/code], the object draws on top of its parent.
 		</member>
 		</member>
@@ -619,6 +616,9 @@
 		<member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0">
 		<member name="texture_repeat" type="int" setter="set_texture_repeat" getter="get_texture_repeat" enum="CanvasItem.TextureRepeat" default="0">
 			The texture repeating mode to use on this [CanvasItem].
 			The texture repeating mode to use on this [CanvasItem].
 		</member>
 		</member>
+		<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
+			If [code]true[/code], the node will not inherit its transform from parent [CanvasItem]s.
+		</member>
 		<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false">
 		<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material" default="false">
 			If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
 			If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
 		</member>
 		</member>

+ 8 - 8
doc/classes/FuncRef.xml

@@ -26,6 +26,13 @@
 				Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].
 				Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array].
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="is_valid" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+				Returns whether the object still exists and has the function assigned.
+			</description>
+		</method>
 		<method name="set_instance">
 		<method name="set_instance">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>
@@ -35,16 +42,9 @@
 				The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
 				The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary].
 			</description>
 			</description>
 		</method>
 		</method>
-		<method name="is_valid" qualifiers="const">
-			<return type="bool">
-			</return>
-			<description>
-				Returns whether the object still exists and has the function assigned.
-			</description>
-		</method>
 	</methods>
 	</methods>
 	<members>
 	<members>
-		<member name="function" type="StringName" setter="set_function" getter="get_function">
+		<member name="function" type="StringName" setter="set_function" getter="get_function" default="@&quot;&quot;">
 			The name of the referenced function.
 			The name of the referenced function.
 		</member>
 		</member>
 	</members>
 	</members>

+ 1 - 1
doc/classes/Node3D.xml

@@ -301,7 +301,7 @@
 		<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
 		<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
 			Scale part of the local transformation.
 			Scale part of the local transformation.
 		</member>
 		</member>
-		<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level">
+		<member name="top_level" type="bool" setter="set_as_top_level" getter="is_set_as_top_level" default="false">
 			If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space.
 			If [code]true[/code], the node will not inherit its transformations from its parent. Node transformations are only in global space.
 		</member>
 		</member>
 		<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
 		<member name="transform" type="Transform" setter="set_transform" getter="get_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">

+ 2 - 2
doc/classes/ProjectSettings.xml

@@ -558,7 +558,7 @@
 		<member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter="" default="false">
 		<member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter="" default="false">
 			If [code]true[/code], sends touch input events when clicking or dragging the mouse.
 			If [code]true[/code], sends touch input events when clicking or dragging the mouse.
 		</member>
 		</member>
-		<member name="input_devices/pointing/ios/touch_delay" type="float" setter="" getter="" default="0.150">
+		<member name="input_devices/pointing/ios/touch_delay" type="float" setter="" getter="" default="0.15">
 			Default delay for touch events. This only affects iOS devices.
 			Default delay for touch events. This only affects iOS devices.
 		</member>
 		</member>
 		<member name="layer_names/2d_physics/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
 		<member name="layer_names/2d_physics/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
@@ -818,7 +818,7 @@
 		<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
 		<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
 			Specifies the maximum amount of log files allowed (used for rotation).
 			Specifies the maximum amount of log files allowed (used for rotation).
 		</member>
 		</member>
-		<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="1024">
+		<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="4096">
 			Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here.
 			Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here.
 		</member>
 		</member>
 		<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
 		<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">

+ 6 - 1
doc/classes/RenderingServer.xml

@@ -583,6 +583,12 @@
 				Modulates all colors in the given canvas.
 				Modulates all colors in the given canvas.
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="create_local_rendering_device" qualifiers="const">
+			<return type="RenderingDevice">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="directional_light_create">
 		<method name="directional_light_create">
 			<return type="RID">
 			<return type="RID">
 			</return>
 			</return>
@@ -1627,7 +1633,6 @@
 			<argument index="3" name="blend_shapes" type="Array" default="[  ]">
 			<argument index="3" name="blend_shapes" type="Array" default="[  ]">
 			</argument>
 			</argument>
 			<argument index="4" name="lods" type="Dictionary" default="{
 			<argument index="4" name="lods" type="Dictionary" default="{
-
 }">
 }">
 			</argument>
 			</argument>
 			<argument index="5" name="compress_format" type="int" default="31744">
 			<argument index="5" name="compress_format" type="int" default="31744">

+ 0 - 6
doc/classes/VisualShaderNode.xml

@@ -57,12 +57,6 @@
 				Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives).
 				Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives).
 			</description>
 			</description>
 		</signal>
 		</signal>
-		<signal name="show_port_preview">
-			<argument index="0" name="port_id" type="int">
-			</argument>
-			<description>
-			</description>
-		</signal>
 	</signals>
 	</signals>
 	<constants>
 	<constants>
 		<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">
 		<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">

+ 0 - 2
modules/webrtc/doc_classes/WebRTCPeerConnection.xml

@@ -40,7 +40,6 @@
 			<argument index="0" name="label" type="String">
 			<argument index="0" name="label" type="String">
 			</argument>
 			</argument>
 			<argument index="1" name="options" type="Dictionary" default="{
 			<argument index="1" name="options" type="Dictionary" default="{
-
 }">
 }">
 			</argument>
 			</argument>
 			<description>
 			<description>
@@ -82,7 +81,6 @@
 			<return type="int" enum="Error">
 			<return type="int" enum="Error">
 			</return>
 			</return>
 			<argument index="0" name="configuration" type="Dictionary" default="{
 			<argument index="0" name="configuration" type="Dictionary" default="{
-
 }">
 }">
 			</argument>
 			</argument>
 			<description>
 			<description>