Update doc format against Godot 3.2-stable

Xrayez · Feb 2, 2020 · 141a1c6 · 141a1c6
1 parent 6104ac1
commit 141a1c6
Show file tree

Hide file tree

Showing 39 changed files with 104 additions and 94 deletions.
diff --git a/doc_classes/AccidentalNoise.xml b/doc_classes/AccidentalNoise.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="AccidentalNoise" inherits="Resource" category="Core" version="3.2">
+<class name="AccidentalNoise" inherits="Resource" version="3.2">
 	<brief_description>
 		A noise module used for compound noise generation.
 	</brief_description>
@@ -431,7 +431,6 @@
 			<argument index="1" name="src2_index" type="int">
 			</argument>
 			<description>
-				Similar to [method bias]. This function has the effect of pushing the values of the input either toward the ends and away from the middle if bias is > 0.5 or pushing values toward the middle and away from the ends if bias is < 0.5.
 			</description>
 		</method>
 		<method name="get_color_2d">
@@ -442,7 +441,6 @@
 			<argument index="1" name="y" type="float">
 			</argument>
 			<description>
-				Evaluates the noise function at [code](x,y)[/code] coordinates and returns a color value.
 			</description>
 		</method>
 		<method name="get_color_2dv">
@@ -1255,41 +1253,41 @@
 		</method>
 	</methods>
 	<members>
-		<member name="bumpmap_light" type="Vector3" setter="set_bumpmap_light" getter="get_bumpmap_light">
+		<member name="bumpmap_light" type="Vector3" setter="set_bumpmap_light" getter="get_bumpmap_light" default="Vector3( 1, 1, 1 )">
 			Controls light direction.
 		</member>
-		<member name="bumpmap_spacing" type="float" setter="set_bumpmap_spacing" getter="get_bumpmap_spacing">
+		<member name="bumpmap_spacing" type="float" setter="set_bumpmap_spacing" getter="get_bumpmap_spacing" default="1.0">
 			Controls how far away the noise is extruded.
 		</member>
-		<member name="bumpmap_wrapped" type="bool" setter="set_bumpmap_wrapped" getter="is_bumpmap_wrapped">
+		<member name="bumpmap_wrapped" type="bool" setter="set_bumpmap_wrapped" getter="is_bumpmap_wrapped" default="true">
 			If set to [code]true[/code], the bump image will be wrapped which is useful for generating seamless bump maps.
 		</member>
-		<member name="expression" type="String" setter="set_expression" getter="get_expression">
+		<member name="expression" type="String" setter="set_expression" getter="get_expression" default="&quot;&quot;">
 			If set, this will override previously created instruction indexes and force to evaluate noise from the expression.
 			Set empty expression to use previously generated noise functions, either via code or visual noise.
 		</member>
-		<member name="format" type="int" setter="set_format" getter="get_format" enum="AccidentalNoise.Format">
+		<member name="format" type="int" setter="set_format" getter="get_format" enum="AccidentalNoise.Format" default="0">
 			Sets the noise format used by [method get_image] and [method get_texture] for noise mapping. See [enum Format].
 		</member>
-		<member name="function" type="int" setter="set_function" getter="get_function">
+		<member name="function" type="int" setter="set_function" getter="get_function" default="0">
 			The index of a function from which noise is evaluated via [method get_noise_2d], [method get_image] or similar.
 		</member>
-		<member name="last_function" type="int" setter="" getter="get_last_function">
+		<member name="last_function" type="int" setter="" getter="get_last_function" default="5">
 			Returns an index of the last noise function generated.
 		</member>
-		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="anl.EMappingModes">
+		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="anl.EMappingModes" default="0">
 			Controls seamlessness of the noise function mapped to image. See [enum EMappingModes].
 		</member>
-		<member name="normalmap_normalized" type="bool" setter="set_normalmap_normalized" getter="is_normalmap_normalized">
+		<member name="normalmap_normalized" type="bool" setter="set_normalmap_normalized" getter="is_normalmap_normalized" default="true">
 			If set to [code]true[/code], normalizes normal map output.
 		</member>
-		<member name="normalmap_spacing" type="float" setter="set_normalmap_spacing" getter="get_normalmap_spacing">
+		<member name="normalmap_spacing" type="float" setter="set_normalmap_spacing" getter="get_normalmap_spacing" default="1.0">
 			Controls how far away the noise is extruded.
 		</member>
-		<member name="normalmap_wrapped" type="bool" setter="set_normalmap_wrapped" getter="is_normalmap_wrapped">
+		<member name="normalmap_wrapped" type="bool" setter="set_normalmap_wrapped" getter="is_normalmap_wrapped" default="true">
 			If set to [code]true[/code], the bump image will be wrapped which is useful for generating seamless normal maps.
 		</member>
-		<member name="ranges" type="AABB" setter="set_ranges" getter="get_ranges">
+		<member name="ranges" type="AABB" setter="set_ranges" getter="get_ranges" default="AABB( -1, -1, -1, 2, 2, 2 )">
 			Controls function's noise mapping ranges to image. Can be set to simulate scale.
 			For 2D, set as [code]AABB(Vector3(-1, -1, 0), Vector3(2, 2, 0))[/code], which corresponds to [code](-1,-1,1,1)[/code].
 		</member>

diff --git a/doc_classes/VisualAccidentalNoise.xml b/doc_classes/VisualAccidentalNoise.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoise" inherits="AccidentalNoise" category="Core" version="3.2">
+<class name="VisualAccidentalNoise" inherits="AccidentalNoise" version="3.2">
 	<brief_description>
 		Accidental Noise visual interface.
 	</brief_description>
@@ -19,13 +19,13 @@
 		</method>
 	</methods>
 	<members>
-		<member name="clamp_high" type="float" setter="set_clamp_high" getter="get_clamp_high">
+		<member name="clamp_high" type="float" setter="set_clamp_high" getter="get_clamp_high" default="1.0">
 			Sets the maximum value by which the noise is clamped when generated.
 		</member>
-		<member name="clamp_low" type="float" setter="set_clamp_low" getter="get_clamp_low">
+		<member name="clamp_low" type="float" setter="set_clamp_low" getter="get_clamp_low" default="0.0">
 			Sets the minimum value by which the noise is clamped when generated.
 		</member>
-		<member name="clamp_output" type="bool" setter="set_clamping_enabled" getter="is_clamping_enabled">
+		<member name="clamp_output" type="bool" setter="set_clamping_enabled" getter="is_clamping_enabled" default="false">
 			If set to [code]true[/code], the last instruction index generated from visual noise nodes will get clamped by [member clamp_low] and [member clamp_high].
 			Warning: if generating color textures, this will turn the image into grayscale.
 		</member>

diff --git a/doc_classes/VisualAccidentalNoiseNode.xml b/doc_classes/VisualAccidentalNoiseNode.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNode" inherits="Resource" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNode" inherits="Resource" version="3.2">
 	<brief_description>
 		Base noise node.
 	</brief_description>
@@ -8,6 +8,12 @@
 	<tutorials>
 	</tutorials>
 	<methods>
+		<method name="get_default_input_values" qualifiers="const">
+			<return type="Array">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_input_port_default_value" qualifiers="const">
 			<return type="Variant">
 			</return>
@@ -16,6 +22,14 @@
 			<description>
 			</description>
 		</method>
+		<method name="set_default_input_values">
+			<return type="void">
+			</return>
+			<argument index="0" name="values" type="Array">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_input_port_default_value">
 			<return type="void">
 			</return>
@@ -28,9 +42,7 @@
 		</method>
 	</methods>
 	<members>
-		<member name="default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values">
-		</member>
-		<member name="output_port_for_preview" type="int" setter="set_output_port_for_preview" getter="get_output_port_for_preview">
+		<member name="output_port_for_preview" type="int" setter="set_output_port_for_preview" getter="get_output_port_for_preview" default="-1">
 		</member>
 	</members>
 	<signals>

diff --git a/doc_classes/VisualAccidentalNoiseNodeCellularBasis.xml b/doc_classes/VisualAccidentalNoiseNodeCellularBasis.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeCellularBasis" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeCellularBasis" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,9 +9,9 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="distance" type="int" setter="set_distance" getter="get_distance">
+		<member name="distance" type="int" setter="set_distance" getter="get_distance" default="0">
 		</member>
-		<member name="seed" type="int" setter="set_seed" getter="get_seed">
+		<member name="seed" type="int" setter="set_seed" getter="get_seed" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeClamp.xml b/doc_classes/VisualAccidentalNoiseNodeClamp.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeClamp" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeClamp" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>

diff --git a/doc_classes/VisualAccidentalNoiseNodeColor.xml b/doc_classes/VisualAccidentalNoiseNodeColor.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeColor" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeColor" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="color" type="Color" setter="set_color" getter="get_color">
+		<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeColorCombine.xml b/doc_classes/VisualAccidentalNoiseNodeColorCombine.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeColorCombine" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeColorCombine" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeColorCombine.CombineMode">
+		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeColorCombine.CombineMode" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeComponent.xml b/doc_classes/VisualAccidentalNoiseNodeComponent.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeComponent" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeComponent" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 		Component noise node.
 	</brief_description>
@@ -140,9 +140,9 @@
 		</method>
 	</methods>
 	<members>
-		<member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset">
+		<member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset" default="Vector2( 0, 0 )">
 		</member>
-		<member name="name" type="String" setter="set_component_name" getter="get_component_name">
+		<member name="name" type="String" setter="set_component_name" getter="get_component_name" default="&quot;component&quot;">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeCurveSection.xml b/doc_classes/VisualAccidentalNoiseNodeCurveSection.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeCurveSection" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeCurveSection" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>

diff --git a/doc_classes/VisualAccidentalNoiseNodeDerivative.xml b/doc_classes/VisualAccidentalNoiseNodeDerivative.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeDerivative" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeDerivative" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Axis.AxisType">
+		<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Axis.AxisType" default="1">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeExpression.xml b/doc_classes/VisualAccidentalNoiseNodeExpression.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeExpression" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeExpression" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="expression" type="String" setter="set_expression" getter="get_expression">
+		<member name="expression" type="String" setter="set_expression" getter="get_expression" default="&quot;&quot;">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeFractal.xml b/doc_classes/VisualAccidentalNoiseNodeFractal.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeFractal" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeFractal" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>

diff --git a/doc_classes/VisualAccidentalNoiseNodeFractalLayer.xml b/doc_classes/VisualAccidentalNoiseNodeFractalLayer.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeFractalLayer" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeFractalLayer" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,9 +9,9 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="basis" type="int" setter="set_basis" getter="get_basis" enum="anl.BasisTypes">
+		<member name="basis" type="int" setter="set_basis" getter="get_basis" enum="anl.BasisTypes" default="2">
 		</member>
-		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeFractalLayer.LayerType">
+		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeFractalLayer.LayerType" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeFractalVariant.xml b/doc_classes/VisualAccidentalNoiseNodeFractalVariant.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeFractalVariant" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeFractalVariant" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,11 +9,11 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="basis" type="int" setter="set_basis" getter="get_basis" enum="anl.BasisTypes">
+		<member name="basis" type="int" setter="set_basis" getter="get_basis" enum="anl.BasisTypes" default="2">
 		</member>
-		<member name="interpolation" type="int" setter="set_interpolation" getter="get_interpolation" enum="anl.InterpolationTypes">
+		<member name="interpolation" type="int" setter="set_interpolation" getter="get_interpolation" enum="anl.InterpolationTypes" default="3">
 		</member>
-		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeFractalVariant.FractalType">
+		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeFractalVariant.FractalType" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeGetVar.xml b/doc_classes/VisualAccidentalNoiseNodeGetVar.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeGetVar" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeGetVar" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="var" type="String" setter="set_var" getter="get_var">
+		<member name="var" type="String" setter="set_var" getter="get_var" default="&quot;name&quot;">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeGradient.xml b/doc_classes/VisualAccidentalNoiseNodeGradient.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeGradient" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeGradient" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Axis.AxisType">
+		<member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Axis.AxisType" default="1">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeGradientBasis.xml b/doc_classes/VisualAccidentalNoiseNodeGradientBasis.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeGradientBasis" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeGradientBasis" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,9 +9,9 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="interpolation" type="int" setter="set_interpolation" getter="get_interpolation">
+		<member name="interpolation" type="int" setter="set_interpolation" getter="get_interpolation" default="0">
 		</member>
-		<member name="seed" type="int" setter="set_seed" getter="get_seed">
+		<member name="seed" type="int" setter="set_seed" getter="get_seed" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeHex.xml b/doc_classes/VisualAccidentalNoiseNodeHex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeHex" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeHex" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeHex.HexType">
+		<member name="type" type="int" setter="set_type" getter="get_type" enum="VisualAccidentalNoiseNodeHex.HexType" default="0">
 		</member>
 	</members>
 	<constants>

diff --git a/doc_classes/VisualAccidentalNoiseNodeInput.xml b/doc_classes/VisualAccidentalNoiseNodeInput.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualAccidentalNoiseNodeInput" inherits="VisualAccidentalNoiseNode" category="Core" version="3.2">
+<class name="VisualAccidentalNoiseNodeInput" inherits="VisualAccidentalNoiseNode" version="3.2">
 	<brief_description>
 	</brief_description>
 	<description>
@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="input_name" type="String" setter="set_input_name" getter="get_input_name">
+		<member name="input_name" type="String" setter="set_input_name" getter="get_input_name" default="&quot;&quot;">
 		</member>
 	</members>
 	<constants>