diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-12 14:30:21 +0100 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-12 14:30:21 +0100 |
commit | 7f9bf5472c299f15f01ccab82d380cd3d946e57f (patch) | |
tree | 64b932b722ff8bb4b7e9eaccb5cd046ebaa15844 | |
parent | 478ab8b45b51ccaafb9db0251ff760e7136e33f6 (diff) |
doc: Sync classref with current source
-rw-r--r-- | doc/classes/KinematicBody.xml | 9 | ||||
-rw-r--r-- | doc/classes/KinematicBody2D.xml | 7 | ||||
-rw-r--r-- | doc/classes/LineEdit.xml | 10 | ||||
-rw-r--r-- | doc/classes/ProjectSettings.xml | 3 | ||||
-rw-r--r-- | doc/classes/SpinBox.xml | 12 | ||||
-rw-r--r-- | doc/classes/TextEdit.xml | 12 | ||||
-rw-r--r-- | doc/classes/VisibilityEnabler.xml | 2 | ||||
-rw-r--r-- | doc/classes/VisibilityEnabler2D.xml | 2 | ||||
-rw-r--r-- | doc/classes/VisualServer.xml | 10 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeFresnel.xml | 2 |
10 files changed, 43 insertions, 26 deletions
diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index 164932749f..f796b15307 100644 --- a/doc/classes/KinematicBody.xml +++ b/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> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index 99a83765eb..1de75cd71b 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/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> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index d428c133af..31cfc15649 100644 --- a/doc/classes/LineEdit.xml +++ b/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> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 1bc43dc964..1e714d92c2 100644 --- a/doc/classes/ProjectSettings.xml +++ b/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> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 1fbced77dc..dfa14fc512 100644 --- a/doc/classes/SpinBox.xml +++ b/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> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index ad2cadb96b..3deed63ae7 100644 --- a/doc/classes/TextEdit.xml +++ b/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"> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 56fa7b77a9..8636d9c8d2 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/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"> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 547793c385..095a377ccb 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/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"> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 6b66721237..c00710ade9 100644 --- a/doc/classes/VisualServer.xml +++ b/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. diff --git a/doc/classes/VisualShaderNodeFresnel.xml b/doc/classes/VisualShaderNodeFresnel.xml index f79ae04abf..b71f5c6f37 100644 --- a/doc/classes/VisualShaderNodeFresnel.xml +++ b/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> |