Ver Fonte

doc: Sync classref with current source

Rémi Verschelde há 6 anos atrás
pai
commit
07e289963c

+ 1 - 1
doc/classes/DirectionalLight.xml

@@ -21,7 +21,7 @@
 		<member name="directional_shadow_depth_range" type="int" setter="set_shadow_depth_range" getter="get_shadow_depth_range" enum="DirectionalLight.ShadowDepthRange" default="0">
 			Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].
 		</member>
-		<member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param" default="200.0">
+		<member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param" default="100.0">
 			The maximum distance for shadow splits.
 		</member>
 		<member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="DirectionalLight.ShadowMode" default="2">

+ 0 - 2
doc/classes/EditorPlugin.xml

@@ -229,7 +229,6 @@
 						forward = true
 					return forward
 				[/codeblock]
-
 			</description>
 		</method>
 		<method name="forward_spatial_gui_input" qualifiers="virtual">
@@ -261,7 +260,6 @@
 						forward = true
 					return forward
 				[/codeblock]
-
 			</description>
 		</method>
 		<method name="get_breakpoints" qualifiers="virtual">

+ 2 - 2
doc/classes/SpatialMaterial.xml

@@ -192,7 +192,7 @@
 		</member>
 		<member name="metallic_texture" type="Texture" setter="set_texture" getter="get_texture">
 		</member>
-		<member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="SpatialMaterial.TextureChannel" default="2">
+		<member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="SpatialMaterial.TextureChannel" default="0">
 		</member>
 		<member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
 			If [code]true[/code], normal mapping is enabled.
@@ -277,7 +277,7 @@
 		</member>
 		<member name="roughness_texture" type="Texture" setter="set_texture" getter="get_texture">
 		</member>
-		<member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="SpatialMaterial.TextureChannel" default="1">
+		<member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="SpatialMaterial.TextureChannel" default="0">
 		</member>
 		<member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
 			If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges.

+ 33 - 33
modules/gdscript/doc_classes/@GDScript.xml

@@ -389,37 +389,6 @@
 				[/codeblock]
 			</description>
 		</method>
-		<method name="posmod">
-			<return type="int">
-			</return>
-			<argument index="0" name="a" type="int">
-			</argument>
-			<argument index="1" name="b" type="int">
-			</argument>
-			<description>
-				Returns the integer modulus of [code]a/b[/code] that wraps equally in positive and negative.
-				[codeblock]
-				var i = -6
-				while i &lt; 5:
-				    prints(i, posmod(i, 3))
-				    i += 1
-				[/codeblock]
-				Produces:
-				[codeblock]
-				-6 0
-				-5 1
-				-4 2
-				-3 0
-				-2 1
-				-1 2
-				0 0
-				1 1
-				2 2
-				3 0
-				4 1
-				[/codeblock]
-			</description>
-		</method>
 		<method name="funcref">
 			<return type="FuncRef">
 			</return>
@@ -753,12 +722,43 @@
 				Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (X and Y axis).
 			</description>
 		</method>
+		<method name="posmod">
+			<return type="int">
+			</return>
+			<argument index="0" name="a" type="int">
+			</argument>
+			<argument index="1" name="b" type="int">
+			</argument>
+			<description>
+				Returns the integer modulus of [code]a/b[/code] that wraps equally in positive and negative.
+				[codeblock]
+				var i = -6
+				while i &lt; 5:
+				    prints(i, posmod(i, 3))
+				    i += 1
+				[/codeblock]
+				Produces:
+				[codeblock]
+				-6 0
+				-5 1
+				-4 2
+				-3 0
+				-2 1
+				-1 2
+				0 0
+				1 1
+				2 2
+				3 0
+				4 1
+				[/codeblock]
+			</description>
+		</method>
 		<method name="pow">
 			<return type="float">
 			</return>
-			<argument index="0" name="x" type="float">
+			<argument index="0" name="base" type="float">
 			</argument>
-			<argument index="1" name="y" type="float">
+			<argument index="1" name="exp" type="float">
 			</argument>
 			<description>
 				Returns the result of [code]x[/code] raised to the power of [code]y[/code].

+ 1 - 0
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml

@@ -212,6 +212,7 @@
 			var t = clamp((weight - from) / (to - from), 0.0, 1.0)
 			return t * t * (3.0 - 2.0 * t)
 			[/codeblock]
+		</constant>
 		<constant name="MATH_POSMOD" value="65" enum="BuiltinFunc">
 		</constant>
 		<constant name="MATH_LERP_ANGLE" value="66" enum="BuiltinFunc">

+ 1 - 1
modules/visual_script/visual_script_builtin_funcs.cpp

@@ -1320,7 +1320,6 @@ void VisualScriptBuiltinFunc::_bind_methods() {
 	BIND_ENUM_CONSTANT(MATH_SQRT);
 	BIND_ENUM_CONSTANT(MATH_FMOD);
 	BIND_ENUM_CONSTANT(MATH_FPOSMOD);
-	BIND_ENUM_CONSTANT(MATH_POSMOD);
 	BIND_ENUM_CONSTANT(MATH_FLOOR);
 	BIND_ENUM_CONSTANT(MATH_CEIL);
 	BIND_ENUM_CONSTANT(MATH_ROUND);
@@ -1373,6 +1372,7 @@ void VisualScriptBuiltinFunc::_bind_methods() {
 	BIND_ENUM_CONSTANT(BYTES_TO_VAR);
 	BIND_ENUM_CONSTANT(COLORN);
 	BIND_ENUM_CONSTANT(MATH_SMOOTHSTEP);
+	BIND_ENUM_CONSTANT(MATH_POSMOD);
 	BIND_ENUM_CONSTANT(MATH_LERP_ANGLE);
 	BIND_ENUM_CONSTANT(FUNC_MAX);
 }