From 7a42df3626159d1d81d2b5aabf13f19ef1951976 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 25 Oct 2018 15:14:36 +0200 Subject: doc: Sync with current source --- doc/classes/AudioServer.xml | 2 ++ doc/classes/GridContainer.xml | 10 ---------- doc/classes/MeshInstance.xml | 6 ++++++ doc/classes/NetworkedMultiplayerPeer.xml | 2 +- doc/classes/Node.xml | 18 +++++++++--------- doc/classes/PackedScene.xml | 6 +----- doc/classes/ProjectSettings.xml | 11 ++++++----- doc/classes/ResourceSaver.xml | 2 ++ doc/classes/SurfaceTool.xml | 4 ++-- modules/opensimplex/doc_classes/NoiseTexture.xml | 6 +++--- 10 files changed, 32 insertions(+), 35 deletions(-) diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 37756bcfd8..8f654441b2 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -385,6 +385,8 @@ Two or fewer speakers are detected. + + A 5.1 channel surround setup detected. diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 8a8a9a2d24..346ab9d357 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -11,16 +11,6 @@ - - - - - - - - - - diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index ef42726ca9..bcc9a7cad9 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -41,6 +41,12 @@ Returns the [Material] for a surface of the [Mesh] resource. + + + + + + diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index ea6fe6d11c..3b76861afd 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -92,7 +92,7 @@ - Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [code]TRANSFER_MODE_UNRELIABLE_ORDERED[/code]. Use for non-critical data, and always consider whether the order matters. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [code]TRANSFER_MODE_UNRELIABLE_ORDERED[/code]. Use for non-critical data, and always consider whether the order matters. Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [code]TRANSFER_MODE_RELIABLE[/code]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index a33ee5c363..19aa2e9f5e 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -179,6 +179,15 @@ If [code]owned[/code] is [code]true[/code], this method only finds nodes whose owner is this node. This is especially important for scenes instantiated through script, because those scenes don't have an owner. + + + + + + + Finds the first parent of the current node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. + + @@ -267,15 +276,6 @@ Returns the parent node of the current node, or an empty [code]Node[/code] if the node lacks a parent. - - - - - - - Finds the first parent of the current node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. - - diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 2284776ccf..19f85fae4c 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -6,11 +6,7 @@ A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see [code]owner[/code] property on [Node]). Note that the node doesn't need to own itself. - - [b]Example of saving a node with different owners[/b] - - The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. - + Example of saving a node with different owners: The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. [codeblock] # create the objects var node = Node2D.new() diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index dfecff9050..3b7356ab39 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -213,6 +213,8 @@ Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system. + + Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing. @@ -230,6 +232,8 @@ + + @@ -372,7 +376,7 @@ Timer setting for incremental search in Tree, IntemList, etc. controls. - + Timer for detecting idle in the editor. @@ -604,9 +608,6 @@ Default size of packet peer stream for deserializing godot data. Over this size, data is dropped. - - Maximum amount of pages used for remote filesystem (used by debugging). - Amount of read ahead used by remote filesystem. Improves latency. @@ -652,7 +653,7 @@ Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not mesh themselves. - + Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index bf3ea95bce..f388667891 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -47,5 +47,7 @@ + + diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 4f9ac68e47..2e5d5d81c9 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -149,7 +149,7 @@ - Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform]. + Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform]. @@ -187,7 +187,7 @@ - Creates a vertex array from an existing [Mesh]. + Creates a vertex array from an existing [Mesh]. diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index d88abb3180..ba54160a90 100644 --- a/modules/opensimplex/doc_classes/NoiseTexture.xml +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -17,6 +17,9 @@ If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map. + + Height of the generated texture. + The [OpenSimplexNoise] instance used to generate the noise. @@ -26,9 +29,6 @@ Width of the generated texture. - - Height of the generated texture. - -- cgit v1.2.3