diff options
Diffstat (limited to 'doc/classes')
35 files changed, 497 insertions, 90 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index aba77afb68..345a769ca5 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -14,6 +14,26 @@ <return type="Variant" /> <argument index="0" name="x" type="Variant" /> <description> + Returns the absolute value of a [Variant] parameter [code]x[/code] (i.e. non-negative value). Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. + [codeblock] + var a = abs(-1) + # a is 1 + + var b = abs(-1.2) + # b is 1.2 + + var c = abs(Vector2(-3.5, -4)) + # c is (3.5, 4) + + var d = abs(Vector2i(-5, -6)) + # d is (5, 6) + + var e = abs(Vector3(-7, 8.5, -3.8)) + # e is (7, 8.5, 3.8) + + var f = abs(Vector3i(-7, -8, -9)) + # f is (7, 8, 9) + [/codeblock] </description> </method> <method name="absf"> @@ -118,6 +138,26 @@ <argument index="1" name="min" type="Variant" /> <argument index="2" name="max" type="Variant" /> <description> + Clamps the [Variant] [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. + [codeblock] + var a = clamp(-10, -1, 5) + # a is -1 + + var b = clamp(8.1, 0.9, 5.5) + # b is 5.5 + + var c = clamp(Vector2(-3.5, -4), Vector2(-3.2, -2), Vector2(2, 6.5)) + # c is (-3.2, -2) + + var d = clamp(Vector2i(7, 8), Vector2i(-3, -2), Vector2i(2, 6)) + # d is (2, 6) + + var e = clamp(Vector3(-7, 8.5, -3.8), Vector3(-3, -2, 5.4), Vector3(-2, 6, -4.1)) + # e is (-3, -2, 5.4) + + var f = clamp(Vector3i(-7, -8, -9), Vector3i(-1, 2, 3), Vector3i(-4, -5, -6)) + # f is (-4, -5, -6) + [/codeblock] </description> </method> <method name="clampf"> @@ -347,6 +387,7 @@ <return type="bool" /> <argument index="0" name="id" type="int" /> <description> + Returns [code]true[/code] if the Object that corresponds to [code]instance_id[/code] is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID. </description> </method> <method name="is_instance_valid"> @@ -525,6 +566,26 @@ [b]Warning:[/b] Due to the way it is implemented, this function returns [code]0[/code] rather than [code]1[/code] for non-positive values of [code]value[/code] (in reality, 1 is the smallest integer power of 2). </description> </method> + <method name="pingpong"> + <return type="float" /> + <argument index="0" name="value" type="float" /> + <argument index="1" name="length" type="float" /> + <description> + Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. + [codeblock] + pingpong(-3.0, 3.0) # Returns 3 + pingpong(-2.0, 3.0) # Returns 2 + pingpong(-1.0, 3.0) # Returns 1 + pingpong(0.0, 3.0) # Returns 0 + pingpong(1.0, 3.0) # Returns 1 + pingpong(2.0, 3.0) # Returns 2 + pingpong(3.0, 3.0) # Returns 3 + pingpong(4.0, 3.0) # Returns 2 + pingpong(5.0, 3.0) # Returns 1 + pingpong(6.0, 3.0) # Returns 0 + [/codeblock] + </description> + </method> <method name="posmod"> <return type="int" /> <argument index="0" name="x" type="int" /> @@ -750,6 +811,14 @@ <return type="Variant" /> <argument index="0" name="x" type="Variant" /> <description> + Returns the sign of [code]x[/code] as same type of [Variant] as [code]x[/code] with each component being -1, 0 and 1 for each negative, zero and positive values respectivelu. Variant types [int], [float] (real), [Vector2], [Vector2i], [Vector3] and [Vector3i] are supported. + [codeblock] + sign(-6.0) # Returns -1 + sign(0.0) # Returns 0 + sign(6.0) # Returns 1 + + sign(Vector3(-6.0, 0.0, 6.0) # Returns (-1, 0, 1) + [/codeblock] </description> </method> <method name="signf"> diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index d7b7a309ad..f353cd19b8 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -57,12 +57,6 @@ Returns this [AABB] expanded to include a given point. </description> </method> - <method name="get_area" qualifiers="const"> - <return type="float" /> - <description> - Returns the volume of the [AABB]. - </description> - </method> <method name="get_center" qualifiers="const"> <return type="Vector3" /> <description> @@ -119,6 +113,12 @@ Returns the support point in a given direction. This is useful for collision detection algorithms. </description> </method> + <method name="get_volume" qualifiers="const"> + <return type="float" /> + <description> + Returns the volume of the [AABB]. + </description> + </method> <method name="grow" qualifiers="const"> <return type="AABB" /> <argument index="0" name="by" type="float" /> @@ -126,16 +126,16 @@ Returns a copy of the [AABB] grown a given amount of units towards all the sides. </description> </method> - <method name="has_no_area" qualifiers="const"> + <method name="has_no_surface" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [AABB] is flat or empty. + Returns [code]true[/code] if the [AABB] is empty. </description> </method> - <method name="has_no_surface" qualifiers="const"> + <method name="has_no_volume" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [AABB] is empty. + Returns [code]true[/code] if the [AABB] is flat or empty. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index e3bb60f6de..dca943dec6 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -551,8 +551,8 @@ The total length of the animation (in seconds). [b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. </member> - <member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false"> - A flag indicating that the animation must loop. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. + <member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="Animation.LoopMode" default="0"> + Determines the behavior of both ends of the animation timeline during animation playback. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. </member> <member name="step" type="float" setter="set_step" getter="get_step" default="0.1"> The animation step value. @@ -610,5 +610,14 @@ <constant name="UPDATE_CAPTURE" value="3" enum="UpdateMode"> Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds. </constant> + <constant name="LOOP_NONE" value="0" enum="LoopMode"> + At both ends of the animation, the animation will stop playing. + </constant> + <constant name="LOOP_LINEAR" value="1" enum="LoopMode"> + At both ends of the animation, the animation will be repeated without changing the playback direction. + </constant> + <constant name="LOOP_PINGPONG" value="2" enum="LoopMode"> + Repeats playback and reverse playback at both ends of the animation. + </constant> </constants> </class> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 173ff43d2a..6bc44ea0a0 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -73,6 +73,7 @@ <argument index="2" name="delta" type="float" /> <argument index="3" name="seeked" type="bool" /> <argument index="4" name="blend" type="float" /> + <argument index="5" name="pingponged" type="int" default="0" /> <description> Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. </description> diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml index 668a35226f..076e675007 100644 --- a/doc/classes/AnimationNodeAnimation.xml +++ b/doc/classes/AnimationNodeAnimation.xml @@ -15,5 +15,14 @@ <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="&"""> Animation to use as an output. It is one of the animations provided by [member AnimationTree.anim_player]. </member> + <member name="play_mode" type="int" setter="set_play_mode" getter="get_play_mode" enum="AnimationNodeAnimation.PlayMode" default="0"> + Determines the playback direction of the animation. + </member> </members> + <constants> + <constant name="PLAY_MODE_FORWARD" value="0" enum="PlayMode"> + </constant> + <constant name="PLAY_MODE_BACKWARD" value="1" enum="PlayMode"> + </constant> + </constants> </class> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 7e1155d89b..df7b5ff1c7 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -61,7 +61,7 @@ <constant name="LOOP_FORWARD" value="1" enum="LoopMode"> Audio loops the data between [member loop_begin] and [member loop_end], playing forward only. </constant> - <constant name="LOOP_PING_PONG" value="2" enum="LoopMode"> + <constant name="LOOP_PINGPONG" value="2" enum="LoopMode"> Audio loops the data between [member loop_begin] and [member loop_end], playing back and forth. </constant> <constant name="LOOP_BACKWARD" value="3" enum="LoopMode"> diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index fe8c354427..ad491465f2 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -126,7 +126,7 @@ Each particle's initial color. To have particle display color in a [BaseMaterial3D] make sure to set [member BaseMaterial3D.vertex_color_use_as_albedo] to [code]true[/code]. </member> <member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp"> - Each particle's color will vary along this [GradientTexture] over its lifetime (multiplied with [member color]). + Each particle's color will vary along this [GradientTexture1D] over its lifetime (multiplied with [member color]). </member> <member name="damping_curve" type="Curve" setter="set_param_curve" getter="get_param_curve"> Damping will vary along this [Curve]. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 5f342e6dc2..5ae034c3ba 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -110,7 +110,7 @@ </signal> <signal name="property_checked"> <argument index="0" name="property" type="StringName" /> - <argument index="1" name="bool" type="String" /> + <argument index="1" name="checked" type="bool" /> <description> Emitted when a property was checked. Used internally. </description> @@ -134,6 +134,14 @@ Emit it if you want to key a property with a single value. </description> </signal> + <signal name="property_pinned"> + <argument index="0" name="property" type="StringName" /> + <argument index="1" name="pinned" type="bool" /> + <description> + Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value. + The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class. + </description> + </signal> <signal name="resource_selected"> <argument index="0" name="path" type="String" /> <argument index="1" name="resource" type="Resource" /> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 88c4689b5f..4ea7f67eed 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -39,7 +39,7 @@ The global brightness value of the rendered scene. Effective only if [code]adjustment_enabled[/code] is [code]true[/code]. </member> <member name="adjustment_color_correction" type="Texture" setter="set_adjustment_color_correction" getter="get_adjustment_color_correction"> - The [Texture2D] or [Texture3D] lookup table (LUT) to use for the built-in post-process color grading. Can use a [GradientTexture] for a 1-dimensional LUT, or a [Texture3D] for a more complex LUT. Effective only if [code]adjustment_enabled[/code] is [code]true[/code]. + The [Texture2D] or [Texture3D] lookup table (LUT) to use for the built-in post-process color grading. Can use a [GradientTexture1D] for a 1-dimensional LUT, or a [Texture3D] for a more complex LUT. Effective only if [code]adjustment_enabled[/code] is [code]true[/code]. </member> <member name="adjustment_contrast" type="float" setter="set_adjustment_contrast" getter="get_adjustment_contrast" default="1.0"> The global contrast value of the rendered scene (default value is 1). Effective only if [code]adjustment_enabled[/code] is [code]true[/code]. diff --git a/doc/classes/FontData.xml b/doc/classes/FontData.xml index 04932ddd2d..ccfe861c92 100644 --- a/doc/classes/FontData.xml +++ b/doc/classes/FontData.xml @@ -93,6 +93,24 @@ Returns font descent (number of pixels below the baseline). </description> </method> + <method name="get_font_name" qualifiers="const"> + <return type="String" /> + <description> + Returns font family name. + </description> + </method> + <method name="get_font_style" qualifiers="const"> + <return type="int" /> + <description> + Returns font style flags, see [enum TextServer.FontStyle]. + </description> + </method> + <method name="get_font_style_name" qualifiers="const"> + <return type="String" /> + <description> + Returns font style name. + </description> + </method> <method name="get_glyph_advance" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="cache_index" type="int" /> @@ -463,6 +481,27 @@ Sets the font descent (number of pixels below the baseline). </description> </method> + <method name="set_font_name"> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <description> + Sets the font family name. + </description> + </method> + <method name="set_font_style"> + <return type="void" /> + <argument index="0" name="style" type="int" /> + <description> + Sets the font style flags, see [enum TextServer.FontStyle]. + </description> + </method> + <method name="set_font_style_name"> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <description> + Sets the font style name. + </description> + </method> <method name="set_force_autohinter"> <return type="void" /> <argument index="0" name="force_autohinter" type="bool" /> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 93cef07b79..baba71b453 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -51,6 +51,12 @@ Removes the color at the index [code]point[/code]. </description> </method> + <method name="reverse"> + <return type="void" /> + <description> + Reverses/mirrors the gradient. + </description> + </method> <method name="set_color"> <return type="void" /> <argument index="0" name="point" type="int" /> @@ -72,8 +78,22 @@ <member name="colors" type="PackedColorArray" setter="set_colors" getter="get_colors" default="PackedColorArray(0, 0, 0, 1, 1, 1, 1, 1)"> Gradient's colors returned as a [PackedColorArray]. </member> + <member name="interpolation_mode" type="int" setter="set_interpolation_mode" getter="get_interpolation_mode" enum="Gradient.InterpolationMode" default="0"> + Defines how the colors between points of the gradient are interpolated. See [enum InterpolationMode] for available modes. + </member> <member name="offsets" type="PackedFloat32Array" setter="set_offsets" getter="get_offsets" default="PackedFloat32Array(0, 1)"> Gradient's offsets returned as a [PackedFloat32Array]. </member> </members> + <constants> + <constant name="GRADIENT_INTERPOLATE_LINEAR" value="0" enum="InterpolationMode"> + Linear interpolation. + </constant> + <constant name="GRADIENT_INTERPOLATE_CONSTANT" value="1" enum="InterpolationMode"> + Constant interpolation, color changes abruptly at each point and stays uniform between. This might cause visible aliasing when used for a gradient texture in some cases. + </constant> + <constant name="GRADIENT_INTERPOLATE_CUBIC" value="2" enum="InterpolationMode"> + Cubic interpolation. + </constant> + </constants> </class> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture1D.xml index 0f0f0b1a37..223439956c 100644 --- a/doc/classes/GradientTexture.xml +++ b/doc/classes/GradientTexture1D.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="GradientTexture" inherits="Texture2D" version="4.0"> +<class name="GradientTexture1D" inherits="Texture2D" version="4.0"> <brief_description> Gradient-filled texture. </brief_description> <description> - GradientTexture uses a [Gradient] to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [member width]). + GradientTexture1D uses a [Gradient] to fill the texture data. The gradient will be filled from left to right using colors obtained from the gradient. This means the texture does not necessarily represent an exact copy of the gradient, but instead an interpolation of samples obtained from the gradient at fixed steps (see [member width]). </description> <tutorials> </tutorials> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index 3c349e052f..24ebf08c36 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -194,7 +194,7 @@ The vertical offset of the text's shadow. </theme_item> <theme_item name="shadow_outline_size" data_type="constant" type="int" default="1"> - Shadow outline size. If set to 1 or greater, the shadow will be displayed around the whole text as an outline. + The size of the shadow outline. </theme_item> </theme_items> </class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index f79ba5a16f..a75bd2f704 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -196,6 +196,9 @@ <member name="expand_to_text_length" type="bool" setter="set_expand_to_text_length_enabled" getter="is_expand_to_text_length_enabled" default="false"> If [code]true[/code], the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened. </member> + <member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false"> + If [code]true[/code], the [LineEdit] don't display decoration. + </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" /> <member name="language" type="String" setter="set_language" getter="get_language" default=""""> Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 618123855f..d0579c6f6f 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -121,5 +121,9 @@ If passed to [method instantiate], provides local scene resources to the local scene. Only the main scene should receive the main edit state. [b]Note:[/b] Only available in editor builds. </constant> + <constant name="GEN_EDIT_STATE_MAIN_INHERITED" value="3" enum="GenEditState"> + It's similar to [constant GEN_EDIT_STATE_MAIN], but for the case where the scene is being instantiated to be the base of another one. + [b]Note:[/b] Only available in editor builds. + </constant> </constants> </class> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 3b583f5c89..2cc0d8f2b0 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -128,7 +128,7 @@ Each particle's initial color. If the [GPUParticles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. To have particle display color in a [BaseMaterial3D] make sure to set [member BaseMaterial3D.vertex_color_use_as_albedo] to [code]true[/code]. </member> <member name="color_ramp" type="Texture2D" setter="set_color_ramp" getter="get_color_ramp"> - Each particle's color will vary along this [GradientTexture] over its lifetime (multiplied with [member color]). + Each particle's color will vary along this [GradientTexture1D] over its lifetime (multiplied with [member color]). </member> <member name="damping_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture"> Damping will vary along this [CurveTexture]. diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index aa189f17f4..3fe9cd776c 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -150,7 +150,10 @@ The body's rotational velocity. </member> <member name="center_of_mass" type="Vector2" setter="" getter="get_center_of_mass"> - The body's center of mass. + The body's center of mass position relative to the body's center in the global coordinate system. + </member> + <member name="center_of_mass_local" type="Vector2" setter="" getter="get_center_of_mass_local"> + The body's center of mass position in the body's local coordinate system. </member> <member name="inverse_inertia" type="float" setter="" getter="get_inverse_inertia"> The inverse of the inertia of the body. diff --git a/doc/classes/PhysicsDirectBodyState3D.xml b/doc/classes/PhysicsDirectBodyState3D.xml index 9bc5dbd6b9..efa9eb9cd6 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -159,7 +159,10 @@ The body's rotational velocity. </member> <member name="center_of_mass" type="Vector3" setter="" getter="get_center_of_mass"> - The body's center of mass. + The body's center of mass position relative to the body's center in the global coordinate system. + </member> + <member name="center_of_mass_local" type="Vector3" setter="" getter="get_center_of_mass_local"> + The body's center of mass position in the body's local coordinate system. </member> <member name="inverse_inertia" type="Vector3" setter="" getter="get_inverse_inertia"> The inverse of the inertia of the body. diff --git a/doc/classes/PhysicsDirectSpaceState2D.xml b/doc/classes/PhysicsDirectSpaceState2D.xml index 887b382267..5892ef266f 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -13,7 +13,7 @@ <methods> <method name="cast_motion"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> Checks how far a [Shape2D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [PhysicsShapeQueryParameters2D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,7 +22,7 @@ </method> <method name="collide_shape"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <argument index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. @@ -31,7 +31,7 @@ </method> <method name="get_rest_info"> <return type="Dictionary" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: @@ -45,51 +45,23 @@ </method> <method name="intersect_point"> <return type="Array" /> - <argument index="0" name="point" type="Vector2" /> + <argument index="0" name="parameters" type="PhysicsPointQueryParameters2D" /> <argument index="1" name="max_results" type="int" default="32" /> - <argument index="2" name="exclude" type="Array" default="[]" /> - <argument index="3" name="collision_mask" type="int" default="4294967295" /> - <argument index="4" name="collide_with_bodies" type="bool" default="true" /> - <argument index="5" name="collide_with_areas" type="bool" default="false" /> <description> - Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: + Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters2D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with [PhysicsBody2D]s or [Area2D]s, respectively. - [b]Note:[/b] [ConcavePolygonShape2D]s and [CollisionPolygon2D]s in [code]Segments[/code] build mode are not solid shapes. Therefore, they will not be detected. - </description> - </method> - <method name="intersect_point_on_canvas"> - <return type="Array" /> - <argument index="0" name="point" type="Vector2" /> - <argument index="1" name="canvas_instance_id" type="int" /> - <argument index="2" name="max_results" type="int" default="32" /> - <argument index="3" name="exclude" type="Array" default="[]" /> - <argument index="4" name="collision_mask" type="int" default="4294967295" /> - <argument index="5" name="collide_with_bodies" type="bool" default="true" /> - <argument index="6" name="collide_with_areas" type="bool" default="false" /> - <description> - Checks whether a point is inside any solid shape, in a specific canvas layer given by [code]canvas_instance_id[/code]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: - [code]collider[/code]: The colliding object. - [code]collider_id[/code]: The colliding object's ID. - [code]rid[/code]: The intersecting object's [RID]. - [code]shape[/code]: The shape index of the colliding shape. - Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with [PhysicsBody2D]s or [Area2D]s, respectively. + The number of intersections can be limited with the [code]max_results[/code] parameter, to reduce the processing time. [b]Note:[/b] [ConcavePolygonShape2D]s and [CollisionPolygon2D]s in [code]Segments[/code] build mode are not solid shapes. Therefore, they will not be detected. </description> </method> <method name="intersect_ray"> <return type="Dictionary" /> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> - <argument index="2" name="exclude" type="Array" default="[]" /> - <argument index="3" name="collision_mask" type="int" default="4294967295" /> - <argument index="4" name="collide_with_bodies" type="bool" default="true" /> - <argument index="5" name="collide_with_areas" type="bool" default="false" /> + <argument index="0" name="parameters" type="PhysicsRayQueryParameters2D" /> <description> - Intersects a ray in a given space. The returned object is a dictionary with the following fields: + Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters2D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]normal[/code]: The object's surface normal at the intersection point. @@ -97,16 +69,14 @@ [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. If the ray did not intersect anything, then an empty dictionary is returned instead. - Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with [PhysicsBody2D]s or [Area2D]s, respectively. </description> </method> <method name="intersect_shape"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters2D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters2D" /> <argument index="1" name="max_results" type="int" default="32" /> <description> - Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. - [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters2D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]rid[/code]: The intersecting object's [RID]. diff --git a/doc/classes/PhysicsDirectSpaceState3D.xml b/doc/classes/PhysicsDirectSpaceState3D.xml index 8c37072f29..6a7fe46518 100644 --- a/doc/classes/PhysicsDirectSpaceState3D.xml +++ b/doc/classes/PhysicsDirectSpaceState3D.xml @@ -13,8 +13,7 @@ <methods> <method name="cast_motion"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" /> - <argument index="1" name="motion" type="Vector3" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <description> Checks how far a [Shape3D] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters3D] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -23,16 +22,17 @@ </method> <method name="collide_shape"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <argument index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters3D] object, second one is in the collided shape from the physics space. + [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. </description> </method> <method name="get_rest_info"> <return type="Dictionary" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. @@ -42,18 +42,27 @@ [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. If the shape did not intersect anything, then an empty dictionary is returned instead. + [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. + </description> + </method> + <method name="intersect_point"> + <return type="Array" /> + <argument index="0" name="parameters" type="PhysicsPointQueryParameters3D" /> + <argument index="1" name="max_results" type="int" default="32" /> + <description> + Checks whether a point is inside any solid shape. Position and other parameters are defined through [PhysicsPointQueryParameters3D]. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: + [code]collider[/code]: The colliding object. + [code]collider_id[/code]: The colliding object's ID. + [code]rid[/code]: The intersecting object's [RID]. + [code]shape[/code]: The shape index of the colliding shape. + The number of intersections can be limited with the [code]max_results[/code] parameter, to reduce the processing time. </description> </method> <method name="intersect_ray"> <return type="Dictionary" /> - <argument index="0" name="from" type="Vector3" /> - <argument index="1" name="to" type="Vector3" /> - <argument index="2" name="exclude" type="Array" default="[]" /> - <argument index="3" name="collision_mask" type="int" default="4294967295" /> - <argument index="4" name="collide_with_bodies" type="bool" default="true" /> - <argument index="5" name="collide_with_areas" type="bool" default="false" /> + <argument index="0" name="parameters" type="PhysicsRayQueryParameters3D" /> <description> - Intersects a ray in a given space. The returned object is a dictionary with the following fields: + Intersects a ray in a given space. Ray position and other parameters are defined through [PhysicsRayQueryParameters3D]. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]normal[/code]: The object's surface normal at the intersection point. @@ -61,12 +70,11 @@ [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. If the ray did not intersect anything, then an empty dictionary is returned instead. - Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to detect (all layers by default), or booleans to determine if the ray should collide with [PhysicsBody3D]s or [Area3D]s, respectively. </description> </method> <method name="intersect_shape"> <return type="Array" /> - <argument index="0" name="shape" type="PhysicsShapeQueryParameters3D" /> + <argument index="0" name="parameters" type="PhysicsShapeQueryParameters3D" /> <argument index="1" name="max_results" type="int" default="32" /> <description> Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters3D] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: @@ -75,6 +83,7 @@ [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. The number of intersections can be limited with the [code]max_results[/code] parameter, to reduce the processing time. + [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. </description> </method> </methods> diff --git a/doc/classes/PhysicsPointQueryParameters2D.xml b/doc/classes/PhysicsPointQueryParameters2D.xml new file mode 100644 index 0000000000..6acd83b101 --- /dev/null +++ b/doc/classes/PhysicsPointQueryParameters2D.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsPointQueryParameters2D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 2D point physics query. + </brief_description> + <description> + This class contains the position and other parameters to be used for [method PhysicsDirectSpaceState2D.intersect_point]. + </description> + <tutorials> + </tutorials> + <members> + <member name="canvas_instance_id" type="int" setter="set_canvas_instance_id" getter="get_canvas_instance_id" default="0"> + If different from [code]0[/code], restricts the query to a specific canvas layer specified by its instance id. See [method Object.get_instance_id]. + </member> + <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> + If [code]true[/code], the query will take [Area2D]s into account. + </member> + <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true"> + If [code]true[/code], the query will take [PhysicsBody2D]s into account. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]"> + The list of objects or object [RID]s that will be excluded from collisions. + </member> + <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)"> + The position being queried for, in global coordinates. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsPointQueryParameters3D.xml b/doc/classes/PhysicsPointQueryParameters3D.xml new file mode 100644 index 0000000000..488f56872d --- /dev/null +++ b/doc/classes/PhysicsPointQueryParameters3D.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsPointQueryParameters3D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 3D point physics query. + </brief_description> + <description> + This class contains the position and other parameters to be used for [method PhysicsDirectSpaceState3D.intersect_point]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> + If [code]true[/code], the query will take [Area3D]s into account. + </member> + <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true"> + If [code]true[/code], the query will take [PhysicsBody3D]s into account. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]"> + The list of objects or object [RID]s that will be excluded from collisions. + </member> + <member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)"> + The position being queried for, in global coordinates. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsRayQueryParameters2D.xml b/doc/classes/PhysicsRayQueryParameters2D.xml new file mode 100644 index 0000000000..0e99e47286 --- /dev/null +++ b/doc/classes/PhysicsRayQueryParameters2D.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsRayQueryParameters2D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 2D ray physics query. + </brief_description> + <description> + This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState2D.intersect_ray]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> + If [code]true[/code], the query will take [Area2D]s into account. + </member> + <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true"> + If [code]true[/code], the query will take [PhysicsBody2D]s into account. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]"> + The list of objects or object [RID]s that will be excluded from collisions. + </member> + <member name="from" type="Vector2" setter="set_from" getter="get_from" default="Vector2(0, 0)"> + The starting point of the ray being queried for, in global coordinates. + </member> + <member name="to" type="Vector2" setter="set_to" getter="get_to" default="Vector2(0, 0)"> + The ending point of the ray being queried for, in global coordinates. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsRayQueryParameters3D.xml b/doc/classes/PhysicsRayQueryParameters3D.xml new file mode 100644 index 0000000000..dbd09e5128 --- /dev/null +++ b/doc/classes/PhysicsRayQueryParameters3D.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsRayQueryParameters3D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 3D ray physics query. + </brief_description> + <description> + This class contains the ray position and other parameters to be used for [method PhysicsDirectSpaceState3D.intersect_ray]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> + If [code]true[/code], the query will take [Area3D]s into account. + </member> + <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_collide_with_bodies_enabled" default="true"> + If [code]true[/code], the query will take [PhysicsBody3D]s into account. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295"> + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. + </member> + <member name="exclude" type="Array" setter="set_exclude" getter="get_exclude" default="[]"> + The list of objects or object [RID]s that will be excluded from collisions. + </member> + <member name="from" type="Vector3" setter="set_from" getter="get_from" default="Vector3(0, 0, 0)"> + The starting point of the ray being queried for, in global coordinates. + </member> + <member name="to" type="Vector3" setter="set_to" getter="get_to" default="Vector3(0, 0, 0)"> + The ending point of the ray being queried for, in global coordinates. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index e44bf71e8d..6f88707259 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -346,7 +346,7 @@ <return type="PhysicsDirectBodyState2D" /> <argument index="0" name="body" type="RID" /> <description> - Returns the [PhysicsDirectBodyState2D] of the body. + Returns the [PhysicsDirectBodyState2D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -919,7 +919,7 @@ Constant to set/get a body's inertia. </constant> <constant name="BODY_PARAM_CENTER_OF_MASS" value="4" enum="BodyParameter"> - Constant to set/get a body's center of mass. + Constant to set/get a body's center of mass position in the body's local coordinate system. </constant> <constant name="BODY_PARAM_GRAVITY_SCALE" value="5" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 0c34cf8092..b144c2c299 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -320,7 +320,7 @@ <return type="PhysicsDirectBodyState3D" /> <argument index="0" name="body" type="RID" /> <description> - Returns the [PhysicsDirectBodyState3D] of the body. + Returns the [PhysicsDirectBodyState3D] of the body. Returns [code]null[/code] if the body is destroyed or removed from the physics space. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -1287,7 +1287,7 @@ Constant to set/get a body's inertia. </constant> <constant name="BODY_PARAM_CENTER_OF_MASS" value="4" enum="BodyParameter"> - Constant to set/get a body's center of mass. + Constant to set/get a body's center of mass position in the body's local coordinate system. </constant> <constant name="BODY_PARAM_GRAVITY_SCALE" value="5" enum="BodyParameter"> Constant to set/get a body's gravity multiplier. diff --git a/doc/classes/PhysicsShapeQueryParameters2D.xml b/doc/classes/PhysicsShapeQueryParameters2D.xml index 6035b662ea..abd19f1326 100644 --- a/doc/classes/PhysicsShapeQueryParameters2D.xml +++ b/doc/classes/PhysicsShapeQueryParameters2D.xml @@ -4,7 +4,7 @@ Parameters to be sent to a 2D shape physics query. </brief_description> <description> - This class contains the shape and other parameters for 2D intersection/collision queries. + This class contains the shape and other parameters for [PhysicsDirectSpaceState2D] intersection/collision queries. </description> <tutorials> </tutorials> diff --git a/doc/classes/PhysicsShapeQueryParameters3D.xml b/doc/classes/PhysicsShapeQueryParameters3D.xml index 1a289ff9d0..2dffd5347a 100644 --- a/doc/classes/PhysicsShapeQueryParameters3D.xml +++ b/doc/classes/PhysicsShapeQueryParameters3D.xml @@ -4,7 +4,7 @@ Parameters to be sent to a 3D shape physics query. </brief_description> <description> - This class contains the shape and other parameters for 3D intersection/collision queries. + This class contains the shape and other parameters for [PhysicsDirectSpaceState3D] intersection/collision queries. </description> <tutorials> </tutorials> @@ -24,6 +24,9 @@ <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> The collision margin for the shape. </member> + <member name="motion" type="Vector3" setter="set_motion" getter="get_motion" default="Vector3(0, 0, 0)"> + The motion of the shape being queried for. + </member> <member name="shape" type="Resource" setter="set_shape" getter="get_shape"> The [Shape3D] that will be used for collision/intersection queries. This stores the actual reference which avoids the shape to be released while being used for queries, so always prefer using this over [member shape_rid]. </member> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 30409814d2..80ef73d824 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1315,9 +1315,9 @@ </member> <member name="mono/profiler/enabled" type="bool" setter="" getter="" default="false"> </member> - <member name="mono/project/auto_update_project" type="bool" setter="" getter="" default="true"> - </member> - <member name="mono/unhandled_exception_policy" type="int" setter="" getter="" default="0"> + <member name="mono/runtime/unhandled_exception_policy" type="int" setter="" getter="" default="0"> + The policy to use for unhandled Mono (C#) exceptions. The default "Terminate Application" exits the project as soon as an unhandled exception is thrown. "Log Error" logs an error message to the console instead, and will not interrupt the project execution when an unhandled exception is thrown. + [b]Note:[/b] The unhandled exception policy is always set to "Log Error" in the editor, which also includes C# [code]tool[/code] scripts running within the editor as well as editor plugin code. </member> <member name="navigation/2d/default_cell_size" type="int" setter="" getter="" default="10"> Default cell size for 2D navigation maps. See [method NavigationServer2D.map_set_cell_size]. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 0fd25615ba..3255c748b7 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -586,15 +586,15 @@ <theme_item name="selection_color" data_type="color" type="Color" default="Color(0.1, 0.1, 1, 0.8)"> The color of the selection box. </theme_item> - <theme_item name="shadow_as_outline" data_type="constant" type="int" default="0"> - Boolean value. If 1 ([code]true[/code]), the shadow will be displayed around the whole text as an outline. - </theme_item> <theme_item name="shadow_offset_x" data_type="constant" type="int" default="1"> The horizontal offset of the font's shadow. </theme_item> <theme_item name="shadow_offset_y" data_type="constant" type="int" default="1"> The vertical offset of the font's shadow. </theme_item> + <theme_item name="shadow_outline_size" data_type="constant" type="int" default="1"> + The size of the shadow outline. + </theme_item> <theme_item name="table_border" data_type="color" type="Color" default="Color(0, 0, 0, 0)"> The default cell border color. </theme_item> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 1c3bac9270..9a22b24825 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -168,5 +168,9 @@ If passed to [method PackedScene.instantiate], provides local scene resources to the local scene. Only the main scene should receive the main edit state. [b]Note:[/b] Only available in editor builds. </constant> + <constant name="GEN_EDIT_STATE_MAIN_INHERITED" value="3" enum="GenEditState"> + If passed to [method PackedScene.instantiate], it's similar to [constant GEN_EDIT_STATE_MAIN], but for the case where the scene is being instantiated to be the base of another one. + [b]Note:[/b] Only available in editor builds. + </constant> </constants> </class> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index 5bd6b0572c..a7122b827e 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -278,6 +278,9 @@ <member name="align" type="int" setter="set_align" getter="get_align" enum="HAlign" default="0"> Paragraph horizontal alignment. </member> + <member name="custom_punctuation" type="String" setter="set_custom_punctuation" getter="get_custom_punctuation" default=""""> + Custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + </member> <member name="direction" type="int" setter="set_direction" getter="get_direction" enum="TextServer.Direction" default="0"> Text writing direction. </member> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 3e32afe370..e1c05165de 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -254,6 +254,13 @@ Returns source font size used to generate MSDF textures. </description> </method> + <method name="font_get_name" qualifiers="const"> + <return type="String" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font family name. + </description> + </method> <method name="font_get_oversampling" qualifiers="const"> <return type="float" /> <argument index="0" name="font_rid" type="RID" /> @@ -300,6 +307,20 @@ Returns extra spacing added between glyphs in pixels. </description> </method> + <method name="font_get_style" qualifiers="const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font style flags, see [enum FontStyle]. + </description> + </method> + <method name="font_get_style_name" qualifiers="const"> + <return type="String" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font style name. + </description> + </method> <method name="font_get_supported_chars" qualifiers="const"> <return type="String" /> <argument index="0" name="font_rid" type="RID" /> @@ -634,6 +655,14 @@ [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. </description> </method> + <method name="font_set_name"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="name" type="String" /> + <description> + Sets the font family name. + </description> + </method> <method name="font_set_oversampling"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> @@ -670,6 +699,22 @@ Sets extra spacing added between glyphs in pixels. </description> </method> + <method name="font_set_style"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="style" type="int" /> + <description> + Sets the font style flags, see [enum FontStyle]. + </description> + </method> + <method name="font_set_style_name"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="name" type="String" /> + <description> + Set the font style name. + </description> + </method> <method name="font_set_texture_image"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> @@ -917,6 +962,13 @@ Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. </description> </method> + <method name="shaped_text_get_custom_punctuation" qualifiers="const"> + <return type="String" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + </description> + </method> <method name="shaped_text_get_descent" qualifiers="const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> @@ -1167,6 +1219,14 @@ Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. </description> </method> + <method name="shaped_text_set_custom_punctuation"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="punct" type="String" /> + <description> + Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + </description> + </method> <method name="shaped_text_set_direction"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> @@ -1402,5 +1462,14 @@ <constant name="SPACING_BOTTOM" value="3" enum="SpacingType"> Spacing at the bottom of the line. </constant> + <constant name="FONT_BOLD" value="1" enum="FontStyle"> + Font is bold. + </constant> + <constant name="FONT_ITALIC" value="2" enum="FontStyle"> + Font is italic or oblique. + </constant> + <constant name="FONT_FIXED_WIDTH" value="4" enum="FontStyle"> + Font have fixed-width characters. + </constant> </constants> </class> diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index 99382d5463..684a1aa755 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -254,6 +254,13 @@ Returns source font size used to generate MSDF textures. </description> </method> + <method name="_font_get_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font family name. + </description> + </method> <method name="_font_get_oversampling" qualifiers="virtual const"> <return type="float" /> <argument index="0" name="font_rid" type="RID" /> @@ -300,6 +307,20 @@ Returns extra spacing added between glyphs in pixels. </description> </method> + <method name="_font_get_style" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font style flags, see [enum TextServer.FontStyle]. + </description> + </method> + <method name="_font_get_style_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font style name. + </description> + </method> <method name="_font_get_supported_chars" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="font_rid" type="RID" /> @@ -641,6 +662,14 @@ If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. </description> </method> + <method name="_font_set_name" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="name" type="String" /> + <description> + Sets the font family name. + </description> + </method> <method name="_font_set_oversampling" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> @@ -677,6 +706,22 @@ Sets extra spacing added between glyphs in pixels. </description> </method> + <method name="_font_set_style" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="style" type="int" /> + <description> + Sets the font style flags, see [enum TextServer.FontStyle]. + </description> + </method> + <method name="_font_set_style_name" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="name_style" type="String" /> + <description> + Sets the font style name. + </description> + </method> <method name="_font_set_texture_image" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> @@ -924,6 +969,13 @@ Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. </description> </method> + <method name="_shaped_text_get_custom_punctuation" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + </description> + </method> <method name="_shaped_text_get_descent" qualifiers="virtual const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> @@ -1176,6 +1228,14 @@ Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. </description> </method> + <method name="_shaped_text_set_custom_punctuation" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="punct" type="String" /> + <description> + Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. + </description> + </method> <method name="_shaped_text_set_direction" qualifiers="virtual"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index b87b59c3e4..58f345b8f9 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -27,8 +27,8 @@ <return type="String" /> <argument index="0" name="input_vars" type="PackedStringArray" /> <argument index="1" name="output_vars" type="String[]" /> - <argument index="2" name="mode" type="int" /> - <argument index="3" name="type" type="int" /> + <argument index="2" name="mode" type="int" enum="Shader.Mode" /> + <argument index="3" name="type" type="int" enum="VisualShader.Type" /> <description> Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). The [code]input_vars[/code] and [code]output_vars[/code] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. @@ -46,7 +46,7 @@ </method> <method name="_get_global_code" qualifiers="virtual const"> <return type="String" /> - <argument index="0" name="mode" type="int" /> + <argument index="0" name="mode" type="int" enum="Shader.Mode" /> <description> Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. |