소스 검색

doc: Sync classref with current source

Rémi Verschelde 5 년 전
부모
커밋
7f9bf5472c

+ 8 - 1
doc/classes/KinematicBody.xml

@@ -21,6 +21,13 @@
 				Returns [code]true[/code] if the specified [code]axis[/code] is locked. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z].
 			</description>
 		</method>
+		<method name="get_floor_normal" qualifiers="const">
+			<return type="Vector3">
+			</return>
+			<description>
+				Returns the normal vector of the floor.
+			</description>
+		</method>
 		<method name="get_floor_velocity" qualifiers="const">
 			<return type="Vector3">
 			</return>
@@ -86,7 +93,7 @@
 			</return>
 			<argument index="0" name="linear_velocity" type="Vector3">
 			</argument>
-			<argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )">
+			<argument index="1" name="up_direction" type="Vector3" default="Vector3( 0, 0, 0 )">
 			</argument>
 			<argument index="2" name="stop_on_slope" type="bool" default="false">
 			</argument>

+ 7 - 0
doc/classes/KinematicBody2D.xml

@@ -13,6 +13,13 @@
 		<link>https://docs.godotengine.org/en/latest/tutorials/physics/using_kinematic_body_2d.html</link>
 	</tutorials>
 	<methods>
+		<method name="get_floor_normal" qualifiers="const">
+			<return type="Vector2">
+			</return>
+			<description>
+                                Returns the normal vector of the floor.
+			</description>
+		</method>
 		<method name="get_floor_velocity" qualifiers="const">
 			<return type="Vector2">
 			</return>

+ 5 - 5
doc/classes/LineEdit.xml

@@ -138,6 +138,11 @@
 		</member>
 	</members>
 	<signals>
+		<signal name="text_change_rejected">
+			<description>
+				Emitted when trying to append text that would overflow the [member max_length].
+			</description>
+		</signal>
 		<signal name="text_changed">
 			<argument index="0" name="new_text" type="String">
 			</argument>
@@ -145,11 +150,6 @@
 				Emitted when the text changes.
 			</description>
 		</signal>
-		<signal name="text_change_rejected">
-			<description>
-				Emitted when trying to append text that would overflow the [member max_length].
-			</description>
-		</signal>
 		<signal name="text_entered">
 			<argument index="0" name="new_text" type="String">
 			</argument>

+ 3 - 0
doc/classes/ProjectSettings.xml

@@ -321,6 +321,9 @@
 		<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="" default="true">
 			If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
 		</member>
+		<member name="debug/gdscript/warnings/standalone_ternary" type="bool" setter="" getter="" default="true">
+			If [code]true[/code], enables warnings when calling a ternary expression that has no effect on the surrounding code, such as writing [code]42 if active else 0[/code] as a statement.
+		</member>
 		<member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="" default="false">
 			If [code]true[/code], all warnings will be reported as if they were errors.
 		</member>

+ 6 - 6
doc/classes/SpinBox.xml

@@ -19,18 +19,18 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="get_line_edit">
-			<return type="LineEdit">
+		<method name="apply">
+			<return type="void">
 			</return>
 			<description>
-				Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit].
+				Applies the current value of this [SpinBox].
 			</description>
 		</method>
-		<method name="apply">
-			<return type="void">
+		<method name="get_line_edit">
+			<return type="LineEdit">
 			</return>
 			<description>
-				Applies the current value of this [SpinBox].
+				Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit].
 			</description>
 		</method>
 	</methods>

+ 6 - 6
doc/classes/TextEdit.xml

@@ -437,6 +437,12 @@
 		<member name="readonly" type="bool" setter="set_readonly" getter="is_readonly" default="false">
 			If [code]true[/code], read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
 		</member>
+		<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
+			The current horizontal scroll value.
+		</member>
+		<member name="scroll_vertical" type="float" setter="set_v_scroll" getter="get_v_scroll" default="0.0">
+			The current vertical scroll value.
+		</member>
 		<member name="selecting_enabled" type="bool" setter="set_selecting_enabled" getter="is_selecting_enabled" default="true">
 		</member>
 		<member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true">
@@ -459,12 +465,6 @@
 		<member name="wrap_enabled" type="bool" setter="set_wrap_enabled" getter="is_wrap_enabled" default="false">
 			If [code]true[/code], enables text wrapping when it goes beyond the edge of what is visible.
 		</member>
-		<member name="scroll_vertical" type="float" setter="set_v_scroll" getter="get_v_scroll" default="0.0">
-			The current vertical scroll value.
-		</member>
-		<member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0">
-			The current horizontal scroll value.
-		</member>
 	</members>
 	<signals>
 		<signal name="breakpoint_toggled">

+ 1 - 1
doc/classes/VisibilityEnabler.xml

@@ -15,7 +15,7 @@
 			<argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler">
 			</argument>
 			<description>
-				Returns whether the enabler identified by given [enum Enabler] constant is active. 
+				Returns whether the enabler identified by given [enum Enabler] constant is active.
 			</description>
 		</method>
 		<method name="set_enabler">

+ 1 - 1
doc/classes/VisibilityEnabler2D.xml

@@ -15,7 +15,7 @@
 			<argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler">
 			</argument>
 			<description>
-				Returns whether the enabler identified by given [enum Enabler] constant is active. 
+				Returns whether the enabler identified by given [enum Enabler] constant is active.
 			</description>
 		</method>
 		<method name="set_enabler">

+ 5 - 5
doc/classes/VisualServer.xml

@@ -2045,7 +2045,7 @@
 			<argument index="2" name="lightmap" type="RID">
 			</argument>
 			<description>
-				Sets the lightmap to use with this instance. 
+				Sets the lightmap to use with this instance.
 			</description>
 		</method>
 		<method name="instance_set_visible">
@@ -3371,7 +3371,7 @@
 			<description>
 				Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]scenario_*[/code] VisualServer functions.
 				Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method.
-				The scenario is the 3D world that all the visual instances exist in. 
+				The scenario is the 3D world that all the visual instances exist in.
 			</description>
 		</method>
 		<method name="scenario_set_debug">
@@ -4857,10 +4857,10 @@
 			Use the filmic tonemapper.
 		</constant>
 		<constant name="ENV_TONE_MAPPER_ACES" value="3" enum="EnvironmentToneMapper">
-			Use the ACES tonemapper. 
+			Use the ACES tonemapper.
 		</constant>
 		<constant name="ENV_SSAO_QUALITY_LOW" value="0" enum="EnvironmentSSAOQuality">
-			Lowest quality of screen space ambient occlusion. 
+			Lowest quality of screen space ambient occlusion.
 		</constant>
 		<constant name="ENV_SSAO_QUALITY_MEDIUM" value="1" enum="EnvironmentSSAOQuality">
 			Medium quality screen space ambient occlusion.
@@ -4872,7 +4872,7 @@
 			Disables the blur set for SSAO. Will make SSAO look noisier.
 		</constant>
 		<constant name="ENV_SSAO_BLUR_1x1" value="1" enum="EnvironmentSSAOBlur">
-			Perform a 1x1 blur on the SSAO output. 
+			Perform a 1x1 blur on the SSAO output.
 		</constant>
 		<constant name="ENV_SSAO_BLUR_2x2" value="2" enum="EnvironmentSSAOBlur">
 			Performs a 2x2 blur on the SSAO output.

+ 1 - 1
doc/classes/VisualShaderNodeFresnel.xml

@@ -9,7 +9,7 @@
 	<methods>
 	</methods>
 	<members>
-		<member name="default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values" override="true" default="[ 0, Vector3( 0, 0, 0 ), 1, Vector3( 0, 0, 0 ), 2, false, 3, 1.0 ]" />
+		<member name="default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values" override="true" default="[ 2, false, 3, 1.0 ]" />
 	</members>
 	<constants>
 	</constants>