From 311bdbc16c4e079143a10fef85e8072fc0b6a774 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 19 Oct 2020 17:13:30 +0200 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/Animation.xml | 22 +++++++++---------- doc/classes/FuncRef.xml | 16 +++++++------- doc/classes/LinkButton.xml | 2 -- doc/classes/MenuButton.xml | 2 -- doc/classes/ProjectSettings.xml | 10 ++++----- doc/classes/Skeleton.xml | 6 +++++ .../doc_classes/VisualScriptPropertyGet.xml | 2 ++ 7 files changed, 32 insertions(+), 28 deletions(-) diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 0bbb4573ead..7de64e64ab1 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -670,6 +670,17 @@ Returns the update mode 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. + + @@ -681,17 +692,6 @@ 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. - - diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index 34984d9feca..3f13948d311 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]. + + + + + Returns whether the object still exists and has the function assigned. + + @@ -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]. - - - - - Returns whether the object still exists and has the function assigned. - - - + The name of the referenced function. diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index 8716eb3cf9d..7b346b1ca40 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -12,8 +12,6 @@ - - The button's text that will be displayed inside the button's area. diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 84878aff0a6..3e9c44cd4f5 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -30,9 +30,7 @@ - - If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 86eddf2053a..00c151f0806 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -570,7 +570,7 @@ If [code]true[/code], sends touch input events when clicking or dragging the mouse. - + Default delay for touch events. This only affects iOS devices. @@ -1192,16 +1192,16 @@ Lower-end override for [member rendering/quality/shadows/filter_mode] on mobile devices, due to performance concerns or driver support. + + Forces [MeshInstance] to always perform skinning on the CPU (applies to both GLES2 and GLES3). + See also [member rendering/quality/skinning/software_skinning_fallback]. + Allows [MeshInstance] to perform skinning on the CPU when the hardware doesn't support the default GPU skinning process with GLES2. If [code]false[/code], an alternative skinning process on the GPU is used in this case (slower in most cases). See also [member rendering/quality/skinning/force_software_skinning]. [b]Note:[/b] When the software skinning fallback is triggered, custom vertex shaders will behave in a different way, because the bone transform will be already applied to the modelview matrix. - - Forces [MeshInstance] to always perform skinning on the CPU (applies to both GLES2 and GLES3). - See also [member rendering/quality/skinning/software_skinning_fallback]. - The rendering octree balance can be changed to favor smaller ([code]0[/code]), or larger ([code]1[/code]) branches. Larger branches can increase performance significantly in some projects. diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 610304f29cb..683c96f10d3 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -266,6 +266,12 @@ + + + + + + diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml index a0b7128e023..463b042ba50 100644 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml @@ -31,5 +31,7 @@ + +