summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-10-09 15:35:10 +0200
committerGitHub <noreply@github.com>2020-10-09 15:35:10 +0200
commitc35005ba25473ea8fa48aadbd1687984c76457cf (patch)
tree344347b544c878201f05a938e4fd70e3caeb5355
parent2e68a283bc92fe49dc109c06a5400ed52dee657f (diff)
parenta33fe750508f9879c51b4917a6212bea10bab40a (diff)
Merge pull request #42672 from akien-mga/doc-classref-sync
doc: Sync classref with current source
-rw-r--r--doc/classes/Animation.xml16
-rw-r--r--doc/classes/ArrayMesh.xml1
-rw-r--r--doc/classes/Basis.xml2
-rw-r--r--doc/classes/CanvasItem.xml6
-rw-r--r--doc/classes/FuncRef.xml16
-rw-r--r--doc/classes/Node3D.xml2
-rw-r--r--doc/classes/ProjectSettings.xml4
-rw-r--r--doc/classes/RenderingServer.xml7
-rw-r--r--doc/classes/VisualShaderNode.xml6
-rw-r--r--modules/webrtc/doc_classes/WebRTCPeerConnection.xml2
10 files changed, 28 insertions, 34 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml
index ceef16f158..d34308501c 100644
--- a/doc/classes/Animation.xml
+++ b/doc/classes/Animation.xml
@@ -681,26 +681,26 @@
Returns the update mode of a value track.
</description>
</method>
- <method name="value_track_set_update_mode">
- <return type="void">
+ <method name="value_track_interpolate" qualifiers="const">
+ <return type="Variant">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
- <argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
+ <argument index="1" name="time_sec" type="float">
</argument>
<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>
</method>
- <method name="value_track_interpolate" qualifiers="const">
- <return type="float">
+ <method name="value_track_set_update_mode">
+ <return type="void">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
- <argument index="1" name="time_sec" type="float">
+ <argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
</argument>
<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>
</method>
</methods>
diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml
index 4edf69ccb2..dc834474ad 100644
--- a/doc/classes/ArrayMesh.xml
+++ b/doc/classes/ArrayMesh.xml
@@ -69,7 +69,6 @@
<argument index="2" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="3" name="lods" type="Dictionary" default="{
-
}">
</argument>
<argument index="4" name="compress_flags" type="int" default="31744">
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index faea2f78b8..42ca3ad24b 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -111,8 +111,6 @@
</return>
<argument index="0" name="b" type="Basis">
</argument>
- <argument index="1" name="epsilon" type="float" default="1e-05">
- </argument>
<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.
</description>
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml
index d36a997330..11000ce8d5 100644
--- a/doc/classes/CanvasItem.xml
+++ b/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">
If [code]true[/code], the object draws behind its parent.
</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">
If [code]true[/code], the object draws on top of its parent.
</member>
@@ -619,6 +616,9 @@
<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].
</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">
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material.
</member>
diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml
index 7c01397c24..dc9246ad35 100644
--- a/doc/classes/FuncRef.xml
+++ b/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].
</description>
</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">
<return type="void">
</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].
</description>
</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>
<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.
</member>
</members>
diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml
index af4f18c5f7..f6ff514474 100644
--- a/doc/classes/Node3D.xml
+++ b/doc/classes/Node3D.xml
@@ -301,7 +301,7 @@
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3( 1, 1, 1 )">
Scale part of the local transformation.
</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.
</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 )">
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 54c337faf9..e9865a6198 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -558,7 +558,7 @@
<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.
</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.
</member>
<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">
Specifies the maximum amount of log files allowed (used for rotation).
</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.
</member>
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 9c8c964967..9ca699501f 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -583,6 +583,12 @@
Modulates all colors in the given canvas.
</description>
</method>
+ <method name="create_local_rendering_device" qualifiers="const">
+ <return type="RenderingDevice">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="directional_light_create">
<return type="RID">
</return>
@@ -1627,7 +1633,6 @@
<argument index="3" name="blend_shapes" type="Array" default="[ ]">
</argument>
<argument index="4" name="lods" type="Dictionary" default="{
-
}">
</argument>
<argument index="5" name="compress_format" type="int" default="31744">
diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml
index 3bb527f3d4..6327ab534f 100644
--- a/doc/classes/VisualShaderNode.xml
+++ b/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).
</description>
</signal>
- <signal name="show_port_preview">
- <argument index="0" name="port_id" type="int">
- </argument>
- <description>
- </description>
- </signal>
</signals>
<constants>
<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">
diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml
index c80b903e39..e21dee8eff 100644
--- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml
+++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml
@@ -40,7 +40,6 @@
<argument index="0" name="label" type="String">
</argument>
<argument index="1" name="options" type="Dictionary" default="{
-
}">
</argument>
<description>
@@ -82,7 +81,6 @@
<return type="int" enum="Error">
</return>
<argument index="0" name="configuration" type="Dictionary" default="{
-
}">
</argument>
<description>