diff options
Diffstat (limited to 'doc/classes')
319 files changed, 7520 insertions, 3390 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index fe0d7e4408..41cc043a74 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1,19 +1,41 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="@GlobalScope" version="4.0"> <brief_description> - Global scope constants and variables. + Global scope constants and functions. </brief_description> <description> - Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc. + A list of global scope enumerated constants and built-in functions. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc. Singletons are also documented here, since they can be accessed from anywhere. + For the entries related to GDScript which can be accessed in any script see [@GDScript]. </description> <tutorials> + <link title="Random number generation">$DOCS_URL/tutorials/math/random_number_generation.html</link> </tutorials> <methods> <method name="abs"> <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 +140,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"> @@ -208,9 +250,9 @@ - 1.0: Linear - Between -1.0 and 0.0 (exclusive): Ease out-in - 0.0: Constant - - Between 0.0 to 1.0 (exclusive): Ease in + - Between 0.0 to 1.0 (exclusive): Ease out - 1.0: Linear - - Greater than 1.0 (exclusive): Ease out + - Greater than 1.0 (exclusive): Ease in [/codeblock] [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/ease_cheatsheet.png]ease() curve values cheatsheet[/url] See also [method smoothstep]. If you need to perform more advanced transitions, use [Tween] or [AnimationPlayer]. @@ -347,6 +389,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 +568,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" /> @@ -662,6 +725,14 @@ [/codeblock] </description> </method> + <method name="randfn"> + <return type="float" /> + <argument index="0" name="mean" type="float" /> + <argument index="1" name="deviation" type="float" /> + <description> + Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. + </description> + </method> <method name="randi"> <return type="int" /> <description> @@ -750,6 +821,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"> @@ -838,7 +917,7 @@ [codeblock] sqrt(9) # Returns 3 [/codeblock] - [b]Note:[/b]Negative values of [code]x[/code] return NaN. If you need negative inputs, use [code]System.Numerics.Complex[/code] in C#. + [b]Note:[/b] Negative values of [code]x[/code] return NaN. If you need negative inputs, use [code]System.Numerics.Complex[/code] in C#. </description> </method> <method name="step_decimals"> @@ -1182,7 +1261,7 @@ <constant name="INLINE_ALIGN_BOTTOM" value="14" enum="InlineAlign"> Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equvalent to [code]INLINE_ALIGN_BOTTOM_TO | INLINE_ALIGN_TO_BOTTOM[/code]. </constant> - <constant name="SPKEY" value="16777216"> + <constant name="KEY_SPECIAL" value="16777216" enum="Key"> Keycodes with this bit applied are non-printable. </constant> <constant name="KEY_ESCAPE" value="16777217" enum="Key"> @@ -1947,12 +2026,6 @@ <constant name="MOUSE_BUTTON_MIDDLE" value="3" enum="MouseButton"> Middle mouse button. </constant> - <constant name="MOUSE_BUTTON_XBUTTON1" value="8" enum="MouseButton"> - Extra mouse button 1 (only present on some mice). - </constant> - <constant name="MOUSE_BUTTON_XBUTTON2" value="9" enum="MouseButton"> - Extra mouse button 2 (only present on some mice). - </constant> <constant name="MOUSE_BUTTON_WHEEL_UP" value="4" enum="MouseButton"> Mouse wheel up. </constant> @@ -1965,6 +2038,12 @@ <constant name="MOUSE_BUTTON_WHEEL_RIGHT" value="7" enum="MouseButton"> Mouse wheel right button (only present on some mice). </constant> + <constant name="MOUSE_BUTTON_XBUTTON1" value="8" enum="MouseButton"> + Extra mouse button 1 (only present on some mice). + </constant> + <constant name="MOUSE_BUTTON_XBUTTON2" value="9" enum="MouseButton"> + Extra mouse button 2 (only present on some mice). + </constant> <constant name="MOUSE_BUTTON_MASK_LEFT" value="1" enum="MouseButton"> Left mouse button mask. </constant> @@ -2340,7 +2419,7 @@ hint_string = "%s/%s:Resource" % [TYPE_OBJECT, TYPE_OBJECT] # Array of resources. hint_string = "%s:%s/%s:Resource" % [TYPE_ARRAY, TYPE_OBJECT, TYPE_OBJECT] # Two-dimensional array of resources. [/codeblock] - [b]Note:[/b] the final colon is required to specify for properly detecting built-in types. + [b]Note:[/b] The final colon is required to specify for properly detecting built-in types. </constant> <constant name="PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE" value="26" enum="PropertyHint"> </constant> @@ -2453,7 +2532,7 @@ <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags"> Default usage for translatable strings (storage, editor, network and internationalized). </constant> - <constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags"> + <constant name="PROPERTY_USAGE_NO_EDITOR" value="5" enum="PropertyUsageFlags"> Default usage but without showing the property in the editor (storage, network). </constant> <constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags"> @@ -2488,16 +2567,16 @@ <constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode"> Used with [method Node.rpc_config] to disable a method or property for all RPC calls, making it unavailable. Default for all methods. </constant> - <constant name="RPC_MODE_ANY" value="1" enum="RPCMode"> + <constant name="RPC_MODE_ANY_PEER" value="1" enum="RPCMode"> Used with [method Node.rpc_config] to set a method to be callable remotely by any peer. Analogous to the [code]@rpc(any)[/code] annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not. </constant> <constant name="RPC_MODE_AUTH" value="2" enum="RPCMode"> Used with [method Node.rpc_config] to set a method to be callable remotely only by the current multiplayer authority (which is the server by default). Analogous to the [code]@rpc(auth)[/code] annotation. See [method Node.set_multiplayer_authority]. </constant> <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> - Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_ORDERED]. Use for non-critical data, and always consider whether the order matters. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_UNRELIABLE_ORDERED]. Use for non-critical data, and always consider whether the order matters. </constant> - <constant name="TRANSFER_MODE_ORDERED" value="1" enum="TransferMode"> + <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [constant TRANSFER_MODE_RELIABLE]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index 5d18f69409..ac45682feb 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -6,35 +6,38 @@ <description> [AABB] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses floating-point coordinates. The 2D counterpart to [AABB] is [Rect2]. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get an AABB with a positive size. [b]Note:[/b] Unlike [Rect2], [AABB] does not have a variant that uses integer coordinates. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> - <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> + <link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link> </tutorials> - <methods> - <method name="AABB" qualifiers="constructor"> + <constructors> + <constructor name="AABB"> <return type="AABB" /> <description> Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="AABB" qualifiers="constructor"> + </constructor> + <constructor name="AABB"> <return type="AABB" /> <argument index="0" name="from" type="AABB" /> <description> Constructs an [AABB] as a copy of the given [AABB]. </description> - </method> - <method name="AABB" qualifiers="constructor"> + </constructor> + <constructor name="AABB"> <return type="AABB" /> <argument index="0" name="position" type="Vector3" /> <argument index="1" name="size" type="Vector3" /> <description> Constructs an [AABB] from a position and size. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="AABB" /> <description> @@ -52,13 +55,22 @@ <return type="AABB" /> <argument index="0" name="to_point" type="Vector3" /> <description> - 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]. + Returns a copy of this [AABB] expanded to include a given point. + [b]Example:[/b] + [codeblocks] + [gdscript] + # position (-3, 2, 0), size (1, 1, 1) + var box = AABB(Vector3(-3, 2, 0), Vector3(1, 1, 1)) + # position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2) + var box2 = box.expand(Vector3(0, -1, 2)) + [/gdscript] + [csharp] + // position (-3, 2, 0), size (1, 1, 1) + var box = new AABB(new Vector3(-3, 2, 0), new Vector3(1, 1, 1)); + // position (-3, -1, 0), size (3, 4, 2), so we fit both the original AABB and Vector3(0, -1, 2) + var box2 = box.Expand(new Vector3(0, -1, 2)); + [/csharp] + [/codeblocks] </description> </method> <method name="get_center" qualifiers="const"> @@ -117,6 +129,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" /> @@ -124,16 +142,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"> @@ -193,45 +211,52 @@ Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="AABB" /> <description> + Returns [code]true[/code] if the vectors are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="AABB" /> <argument index="0" name="right" type="Transform3D" /> <description> + Inversely transforms (multiplies) the [AABB] by the given [Transform3D] transformation matrix. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="AABB" /> <description> + Returns [code]true[/code] if the AABBs are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> - </method> - </methods> - <members> - <member name="end" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/AESContext.xml b/doc/classes/AESContext.xml index 847d1226a2..8c390155ee 100644 --- a/doc/classes/AESContext.xml +++ b/doc/classes/AESContext.xml @@ -89,7 +89,7 @@ <return type="PackedByteArray" /> <description> Get the current IV state for this context (IV gets updated when calling [method update]). You normally don't need this function. - Note: This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. + [b]Note:[/b] This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. </description> </method> <method name="start"> @@ -106,7 +106,7 @@ <argument index="0" name="src" type="PackedByteArray" /> <description> Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation. - Note: The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed. + [b]Note:[/b] The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed. </description> </method> </methods> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 11c0fc33b8..bbb5f6b8e3 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -244,6 +244,12 @@ Returns the number of points currently in the points pool. </description> </method> + <method name="get_point_ids"> + <return type="Array" /> + <description> + Returns an array of all point IDs. + </description> + </method> <method name="get_point_path"> <return type="PackedVector3Array" /> <argument index="0" name="from_id" type="int" /> @@ -267,12 +273,6 @@ Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> - <method name="get_points"> - <return type="Array" /> - <description> - Returns an array of all points. - </description> - </method> <method name="has_point" qualifiers="const"> <return type="bool" /> <argument index="0" name="id" type="int" /> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 43e7d59665..dc821ebb8b 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -215,6 +215,12 @@ Returns the number of points currently in the points pool. </description> </method> + <method name="get_point_ids"> + <return type="Array" /> + <description> + Returns an array of all point IDs. + </description> + </method> <method name="get_point_path"> <return type="PackedVector2Array" /> <argument index="0" name="from_id" type="int" /> @@ -238,12 +244,6 @@ Returns the weight scale of the point associated with the given [code]id[/code]. </description> </method> - <method name="get_points"> - <return type="Array" /> - <description> - Returns an array of all points. - </description> - </method> <method name="has_point" qualifiers="const"> <return type="bool" /> <argument index="0" name="id" type="int" /> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index c753b341d2..df0cc6f268 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -32,12 +32,14 @@ <return type="Label" /> <description> Returns the label used for built-in text. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_ok_button"> <return type="Button" /> <description> Returns the OK [Button] instance. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="register_text_enter"> diff --git a/doc/classes/AnimatedSprite2D.xml b/doc/classes/AnimatedSprite2D.xml index b468e1d109..789c6bd960 100644 --- a/doc/classes/AnimatedSprite2D.xml +++ b/doc/classes/AnimatedSprite2D.xml @@ -8,7 +8,7 @@ [b]Note:[/b] You can associate a set of normal or specular maps by creating additional [SpriteFrames] resources with a [code]_normal[/code] or [code]_specular[/code] suffix. For example, having 3 [SpriteFrames] resources [code]run[/code], [code]run_normal[/code], and [code]run_specular[/code] will make it so the [code]run[/code] animation uses normal and specular maps. </description> <tutorials> - <link title="2D Sprite animation">https://docs.godotengine.org/en/latest/tutorials/2d/2d_sprite_animation.html</link> + <link title="2D Sprite animation">$DOCS_URL/tutorials/2d/2d_sprite_animation.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> </tutorials> <methods> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 59d7553ef4..38a87c1b2b 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -7,7 +7,7 @@ Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel. </description> <tutorials> - <link title="2D Sprite animation (also applies to 3D)">https://docs.godotengine.org/en/latest/tutorials/2d/2d_sprite_animation.html</link> + <link title="2D Sprite animation (also applies to 3D)">$DOCS_URL/tutorials/2d/2d_sprite_animation.html</link> </tutorials> <methods> <method name="is_playing" qualifiers="const"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 38e02745d4..bb4089d67e 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -28,7 +28,7 @@ Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check [enum TrackType] to see available types. </description> <tutorials> - <link title="Animation tutorial index">https://docs.godotengine.org/en/latest/tutorials/animation/index.html</link> + <link title="Animation documentation index">$DOCS_URL/tutorials/animation/index.html</link> </tutorials> <methods> <method name="add_track"> @@ -130,6 +130,14 @@ Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track. </description> </method> + <method name="bezier_track_get_key_handle_mode" qualifiers="const"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="key_idx" type="int" /> + <description> + Returns the handle mode of the key identified by [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. + </description> + </method> <method name="bezier_track_get_key_in_handle" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="track_idx" type="int" /> @@ -161,6 +169,7 @@ <argument index="2" name="value" type="float" /> <argument index="3" name="in_handle" type="Vector2" default="Vector2(0, 0)" /> <argument index="4" name="out_handle" type="Vector2" default="Vector2(0, 0)" /> + <argument index="5" name="handle_mode" type="int" enum="Animation.HandleMode" default="1" /> <description> Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. @@ -174,11 +183,22 @@ Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> + <method name="bezier_track_set_key_handle_mode"> + <return type="void" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="key_idx" type="int" /> + <argument index="2" name="key_handle_mode" type="int" enum="Animation.HandleMode" /> + <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> + <description> + Changes the handle mode of the keyframe at the given [code]index[/code]. See [enum HandleMode] for possible values. The [code]track_idx[/code] must be the index of a Bezier Track. + </description> + </method> <method name="bezier_track_set_key_in_handle"> <return type="void" /> <argument index="0" name="track_idx" type="int" /> <argument index="1" name="key_idx" type="int" /> <argument index="2" name="in_handle" type="Vector2" /> + <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> <description> Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> @@ -188,6 +208,7 @@ <argument index="0" name="track_idx" type="int" /> <argument index="1" name="key_idx" type="int" /> <argument index="2" name="out_handle" type="Vector2" /> + <argument index="3" name="balanced_value_time_ratio" type="float" default="1.0" /> <description> Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. </description> @@ -201,12 +222,28 @@ Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> + <method name="blend_shape_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="amount" type="float" /> + <description> + </description> + </method> <method name="clear"> <return type="void" /> <description> Clear the animation (clear all tracks and reset all). </description> </method> + <method name="compress"> + <return type="void" /> + <argument index="0" name="page_size" type="int" default="8192" /> + <argument index="1" name="fps" type="int" default="120" /> + <argument index="2" name="split_tolerance" type="float" default="4.0" /> + <description> + </description> + </method> <method name="copy_track"> <return type="void" /> <argument index="0" name="track_idx" type="int" /> @@ -218,6 +255,7 @@ <method name="find_track" qualifiers="const"> <return type="int" /> <argument index="0" name="path" type="NodePath" /> + <argument index="1" name="type" type="int" enum="Animation.TrackType" /> <description> Returns the index of the specified track. If the track is not found, return -1. </description> @@ -253,6 +291,14 @@ Returns the arguments values to be called on a method track for a given key in a given track. </description> </method> + <method name="position_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="position" type="Vector3" /> + <description> + </description> + </method> <method name="remove_track"> <return type="void" /> <argument index="0" name="track_idx" type="int" /> @@ -260,6 +306,22 @@ Removes a track by specifying the track index. </description> </method> + <method name="rotation_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="rotation" type="Quaternion" /> + <description> + </description> + </method> + <method name="scale_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="scale" type="Vector3" /> + <description> + </description> + </method> <method name="track_find_key" qualifiers="const"> <return type="int" /> <argument index="0" name="track_idx" type="int" /> @@ -338,6 +400,12 @@ Insert a generic key in a given track. </description> </method> + <method name="track_is_compressed" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="track_idx" type="int" /> + <description> + </description> + </method> <method name="track_is_enabled" qualifiers="const"> <return type="bool" /> <argument index="0" name="track_idx" type="int" /> @@ -466,25 +534,6 @@ Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. </description> </method> - <method name="transform_track_insert_key"> - <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="location" type="Vector3" /> - <argument index="3" name="rotation" type="Quaternion" /> - <argument index="4" name="scale" type="Vector3" /> - <description> - Insert a transform key for a transform track. - </description> - </method> - <method name="transform_track_interpolate" qualifiers="const"> - <return type="Array" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time_sec" type="float" /> - <description> - Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quaternion]) and scale ([Vector3]). - </description> - </method> <method name="value_track_get_key_indices" qualifiers="const"> <return type="PackedInt32Array" /> <argument index="0" name="track_idx" type="int" /> @@ -523,8 +572,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. @@ -541,19 +590,24 @@ <constant name="TYPE_VALUE" value="0" enum="TrackType"> Value tracks set values in node properties, but only those which can be Interpolated. </constant> - <constant name="TYPE_TRANSFORM3D" value="1" enum="TrackType"> - Transform3D tracks are used to change node local transforms or skeleton pose bones of 3D nodes. Transitions are interpolated. + <constant name="TYPE_POSITION_3D" value="1" enum="TrackType"> </constant> - <constant name="TYPE_METHOD" value="2" enum="TrackType"> + <constant name="TYPE_ROTATION_3D" value="2" enum="TrackType"> + </constant> + <constant name="TYPE_SCALE_3D" value="3" enum="TrackType"> + </constant> + <constant name="TYPE_BLEND_SHAPE" value="4" enum="TrackType"> + </constant> + <constant name="TYPE_METHOD" value="5" enum="TrackType"> Method tracks call functions with given arguments per key. </constant> - <constant name="TYPE_BEZIER" value="3" enum="TrackType"> + <constant name="TYPE_BEZIER" value="6" enum="TrackType"> Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a [Color]). </constant> - <constant name="TYPE_AUDIO" value="4" enum="TrackType"> + <constant name="TYPE_AUDIO" value="7" enum="TrackType"> Audio tracks are used to play an audio stream with either type of [AudioStreamPlayer]. The stream can be trimmed and previewed in the animation. </constant> - <constant name="TYPE_ANIMATION" value="5" enum="TrackType"> + <constant name="TYPE_ANIMATION" value="8" enum="TrackType"> Animation tracks play animations in other [AnimationPlayer] nodes. </constant> <constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType"> @@ -577,5 +631,20 @@ <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> + <constant name="HANDLE_MODE_FREE" value="0" enum="HandleMode"> + Assigning the free handle mode to a Bezier Track's keyframe allows you to edit the keyframe's left and right handles independently from one another. + </constant> + <constant name="HANDLE_MODE_BALANCED" value="1" enum="HandleMode"> + Assigning the balanced handle mode to a Bezier Track's keyframe makes it so the two handles of the keyframe always stay aligned when changing either the keyframe's left or right handle. + </constant> </constants> </class> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 173ff43d2a..c9d8ae9936 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -8,7 +8,7 @@ Inherit this when creating nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <methods> <method name="_get_caption" qualifiers="virtual const"> @@ -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/AnimationNodeAdd2.xml b/doc/classes/AnimationNodeAdd2.xml index 20ee33209b..472f98a5b3 100644 --- a/doc/classes/AnimationNodeAdd2.xml +++ b/doc/classes/AnimationNodeAdd2.xml @@ -7,7 +7,7 @@ A resource to add to an [AnimationNodeBlendTree]. Blends two animations additively based on an amount value in the [code][0.0, 1.0][/code] range. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <members> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync" default="false"> diff --git a/doc/classes/AnimationNodeAdd3.xml b/doc/classes/AnimationNodeAdd3.xml index 26738499bb..9ba4023b79 100644 --- a/doc/classes/AnimationNodeAdd3.xml +++ b/doc/classes/AnimationNodeAdd3.xml @@ -11,7 +11,7 @@ - A +add animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <members> diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml index 668a35226f..3df92ad3d3 100644 --- a/doc/classes/AnimationNodeAnimation.xml +++ b/doc/classes/AnimationNodeAnimation.xml @@ -7,7 +7,7 @@ A resource to add to an [AnimationNodeBlendTree]. Only features one output set using the [member animation] property. Use it as an input for [AnimationNode] that blend animations together. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> @@ -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/AnimationNodeBlend2.xml b/doc/classes/AnimationNodeBlend2.xml index 1f7a4c91c8..3b869bc299 100644 --- a/doc/classes/AnimationNodeBlend2.xml +++ b/doc/classes/AnimationNodeBlend2.xml @@ -7,7 +7,7 @@ A resource to add to an [AnimationNodeBlendTree]. Blends two animations linearly based on an amount value in the [code][0.0, 1.0][/code] range. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> diff --git a/doc/classes/AnimationNodeBlend3.xml b/doc/classes/AnimationNodeBlend3.xml index ed827e2535..ae8fce51f2 100644 --- a/doc/classes/AnimationNodeBlend3.xml +++ b/doc/classes/AnimationNodeBlend3.xml @@ -11,7 +11,7 @@ - A +blend animation to blend with when the blend amount is in the [code][0.0, 1.0][/code] range </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <members> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync" default="false"> diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index 6e55a79fd2..831542b64c 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -10,7 +10,7 @@ You can set the extents of the axis using the [member min_space] and [member max_space]. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <methods> <method name="add_blend_point"> diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index 8d51f9aecc..77d1d872e5 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -9,7 +9,7 @@ You can add vertices to the blend space with [method add_blend_point] and automatically triangulate it by setting [member auto_triangles] to [code]true[/code]. Otherwise, use [method add_triangle] and [method remove_triangle] to create up the blend space by hand. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index da532dc059..a9f1f7acaa 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -7,7 +7,7 @@ This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <methods> <method name="add_node"> diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index 2ecc0ae07b..116b54e39e 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -7,7 +7,7 @@ A resource to add to an [AnimationNodeBlendTree]. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> diff --git a/doc/classes/AnimationNodeOutput.xml b/doc/classes/AnimationNodeOutput.xml index 34c96d13ea..6241a0fa49 100644 --- a/doc/classes/AnimationNodeOutput.xml +++ b/doc/classes/AnimationNodeOutput.xml @@ -6,7 +6,7 @@ <description> </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 17ef565b3a..5adea7308d 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -18,7 +18,7 @@ [/codeblocks] </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <methods> <method name="add_node"> diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 15c6c96302..b299f8654a 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -18,7 +18,7 @@ [/codeblocks] </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <methods> <method name="get_current_length" qualifiers="const"> diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index 763bba6e93..948e3506a9 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -5,11 +5,11 @@ <description> </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> <members> <member name="advance_condition" type="StringName" setter="set_advance_condition" getter="get_advance_condition" default="&"""> - Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to [code]"idle"[/code]: + Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=$DOCS_URL/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to [code]"idle"[/code]: [codeblocks] [gdscript] $animation_tree.set("parameters/conditions/idle", is_on_floor and (linear_velocity.x == 0)) diff --git a/doc/classes/AnimationNodeTimeScale.xml b/doc/classes/AnimationNodeTimeScale.xml index 5b40b39bca..33e0127a52 100644 --- a/doc/classes/AnimationNodeTimeScale.xml +++ b/doc/classes/AnimationNodeTimeScale.xml @@ -7,7 +7,7 @@ Allows scaling the speed of the animation (or reversing it) in any children nodes. Setting it to 0 will pause the animation. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> </tutorials> </class> diff --git a/doc/classes/AnimationNodeTimeSeek.xml b/doc/classes/AnimationNodeTimeSeek.xml index d927c663c8..868319272e 100644 --- a/doc/classes/AnimationNodeTimeSeek.xml +++ b/doc/classes/AnimationNodeTimeSeek.xml @@ -27,6 +27,6 @@ [/codeblocks] </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> </tutorials> </class> diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index b297832ac0..48961f51a5 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -7,7 +7,7 @@ Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified. </description> <tutorials> - <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 1ef9d81d02..9f68edbc92 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -9,8 +9,8 @@ Updating the target properties of animations occurs at process time. </description> <tutorials> - <link title="2D Sprite animation">https://docs.godotengine.org/en/latest/tutorials/2d/2d_sprite_animation.html</link> - <link title="Animation tutorial index">https://docs.godotengine.org/en/latest/tutorials/animation/index.html</link> + <link title="2D Sprite animation">$DOCS_URL/tutorials/2d/2d_sprite_animation.html</link> + <link title="Animation documentation index">$DOCS_URL/tutorials/animation/index.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> @@ -188,7 +188,7 @@ </member> <member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation" default=""""> The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See [method play] for more information on playing animations. - [b]Note[/b]: while this property appears in the inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see [Animation]. + [b]Note:[/b] while this property appears in the inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see [Animation]. </member> <member name="current_animation_length" type="float" setter="" getter="get_current_animation_length"> The length (in seconds) of the currently being played animation. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 843dd5a6d1..48c5398074 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -4,10 +4,11 @@ A node to be used for advanced animation transitions in an [AnimationPlayer]. </brief_description> <description> - Note: When linked with an [AnimationPlayer], several properties and methods of the corresponding [AnimationPlayer] will not function as expected. Playback and transitions should be handled using only the [AnimationTree] and its constituent [AnimationNode](s). The [AnimationPlayer] node should be used solely for adding, deleting, and editing animations. + A node to be used for advanced animation transitions in an [AnimationPlayer]. + [b]Note:[/b] When linked with an [AnimationPlayer], several properties and methods of the corresponding [AnimationPlayer] will not function as expected. Playback and transitions should be handled using only the [AnimationTree] and its constituent [AnimationNode](s). The [AnimationPlayer] node should be used solely for adding, deleting, and editing animations. </description> <tutorials> - <link title="Using AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> + <link title="Using AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> @@ -21,7 +22,7 @@ <method name="get_root_motion_transform" qualifiers="const"> <return type="Transform3D" /> <description> - Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. + Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_SCALE_3D] or [constant Animation.TYPE_ROTATION_3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. </description> </method> <method name="rename_parameter"> @@ -44,7 +45,7 @@ </member> <member name="root_motion_track" type="NodePath" setter="set_root_motion_track" getter="get_root_motion_track" default="NodePath("")"> The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. - If the track has type [constant Animation.TYPE_TRANSFORM3D], the transformation will be cancelled visually, and the animation will appear to stay in place. See also [method get_root_motion_transform] and [RootMotionView]. + If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be cancelled visually, and the animation will appear to stay in place. See also [method get_root_motion_transform] and [RootMotionView]. </member> <member name="tree_root" type="AnimationNode" setter="set_tree_root" getter="get_tree_root"> The root animation node of this [AnimationTree]. See [AnimationNode]. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 25f67f0571..0f7e6799be 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -7,7 +7,7 @@ 2D area that detects [CollisionObject2D] nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping) and route audio to a custom audio bus. </description> <tutorials> - <link title="Using Area2D">https://docs.godotengine.org/en/latest/tutorials/physics/using_area_2d.html</link> + <link title="Using Area2D">$DOCS_URL/tutorials/physics/using_area_2d.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="2D Pong Demo">https://godotengine.org/asset-library/asset/121</link> <link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link> @@ -16,13 +16,15 @@ <method name="get_overlapping_areas" qualifiers="const"> <return type="Area2D[]" /> <description> - Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [Area2D]s. The overlapping area's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Node2D[]" /> <description> - Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [PhysicsBody2D]s. The overlapping body's [member CollisionObject2D.collision_layer] must be part of this area's [member CollisionObject2D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -48,6 +50,9 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_space_override" type="int" setter="set_angular_damp_space_override_mode" getter="get_angular_damp_space_override_mode" enum="Area2D.SpaceOverride" default="0"> + Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + </member> <member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="&"Master""> The name of the area's audio bus. </member> @@ -55,21 +60,30 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. </member> <member name="gravity" type="float" setter="set_gravity" getter="get_gravity" default="980.0"> - The area's gravity intensity (in pixels per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + The area's gravity intensity (in pixels per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. </member> - <member name="gravity_distance_scale" type="float" setter="set_gravity_distance_scale" getter="get_gravity_distance_scale" default="0.0"> - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + <member name="gravity_direction" type="Vector2" setter="set_gravity_direction" getter="get_gravity_direction" default="Vector2(0, 1)"> + The area's gravity vector (not normalized). </member> <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point" default="false"> - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_point_center]). See also [member gravity_space_override]. </member> - <member name="gravity_vec" type="Vector2" setter="set_gravity_vector" getter="get_gravity_vector" default="Vector2(0, 1)"> - The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. + <member name="gravity_point_center" type="Vector2" setter="set_gravity_point_center" getter="get_gravity_point_center" default="Vector2(0, 1)"> + If gravity is a point (see [member gravity_point]), this will be the point of attraction. + </member> + <member name="gravity_point_distance_scale" type="float" setter="set_gravity_point_distance_scale" getter="get_gravity_point_distance_scale" default="0.0"> + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + </member> + <member name="gravity_space_override" type="int" setter="set_gravity_space_override_mode" getter="get_gravity_space_override_mode" enum="Area2D.SpaceOverride" default="0"> + Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.1"> The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_space_override" type="int" setter="set_linear_damp_space_override_mode" getter="get_linear_damp_space_override_mode" enum="Area2D.SpaceOverride" default="0"> + Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + </member> <member name="monitorable" type="bool" setter="set_monitorable" getter="is_monitorable" default="true"> If [code]true[/code], other monitoring areas can detect this area. </member> @@ -79,9 +93,6 @@ <member name="priority" type="float" setter="set_priority" getter="get_priority" default="0.0"> The area's priority. Higher priority areas are processed first. </member> - <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area2D.SpaceOverride" default="0"> - Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. - </member> </members> <signals> <signal name="area_entered"> @@ -101,27 +112,27 @@ <signal name="area_shape_entered"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. + [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area[/code] the other Area2D. - [code]area_shape[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]area_shape_index[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="area_shape_exited"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. + [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area[/code] the other Area2D. - [code]area_shape[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]area_shape_index[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_entered"> @@ -141,27 +152,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> </signals> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index e91cfd79a1..450ed44307 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -14,13 +14,15 @@ <method name="get_overlapping_areas" qualifiers="const"> <return type="Area3D[]" /> <description> - Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [Area3D]s. The overlapping area's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Node3D[]" /> <description> - Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. + Returns a list of intersecting [PhysicsBody3D]s. The overlapping body's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] in order to be detected. + For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -46,6 +48,9 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_space_override" type="int" setter="set_angular_damp_space_override_mode" getter="get_angular_damp_space_override_mode" enum="Area3D.SpaceOverride" default="0"> + Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + </member> <member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="&"Master""> The name of the area's audio bus. </member> @@ -53,21 +58,30 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. </member> <member name="gravity" type="float" setter="set_gravity" getter="get_gravity" default="9.8"> - The area's gravity intensity (in meters per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. </member> - <member name="gravity_distance_scale" type="float" setter="set_gravity_distance_scale" getter="get_gravity_distance_scale" default="0.0"> - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + <member name="gravity_direction" type="Vector3" setter="set_gravity_direction" getter="get_gravity_direction" default="Vector3(0, -1, 0)"> + The area's gravity vector (not normalized). </member> <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point" default="false"> - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_point_center]). See also [member gravity_space_override]. + </member> + <member name="gravity_point_center" type="Vector3" setter="set_gravity_point_center" getter="get_gravity_point_center" default="Vector3(0, -1, 0)"> + If gravity is a point (see [member gravity_point]), this will be the point of attraction. + </member> + <member name="gravity_point_distance_scale" type="float" setter="set_gravity_point_distance_scale" getter="get_gravity_point_distance_scale" default="0.0"> + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. </member> - <member name="gravity_vec" type="Vector3" setter="set_gravity_vector" getter="get_gravity_vector" default="Vector3(0, -1, 0)"> - The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. + <member name="gravity_space_override" type="int" setter="set_gravity_space_override_mode" getter="get_gravity_space_override_mode" enum="Area3D.SpaceOverride" default="0"> + Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.1"> The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_space_override" type="int" setter="set_linear_damp_space_override_mode" getter="get_linear_damp_space_override_mode" enum="Area3D.SpaceOverride" default="0"> + Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + </member> <member name="monitorable" type="bool" setter="set_monitorable" getter="is_monitorable" default="true"> If [code]true[/code], other monitoring areas can detect this area. </member> @@ -89,9 +103,6 @@ <member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity" default="0.0"> The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. </member> - <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area3D.SpaceOverride" default="0"> - Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. - </member> <member name="wind_attenuation_factor" type="float" setter="set_wind_attenuation_factor" getter="get_wind_attenuation_factor" default="0.0"> The exponential rate at which wind force decreases with distance from its origin. </member> @@ -120,27 +131,27 @@ <signal name="area_shape_entered"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. + [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area[/code] the other Area3D. - [code]area_shape[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]area_shape_index[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="area_shape_exited"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> - Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. + Emitted when one of another Area3D's [Shape3D]s exits one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. + [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area[/code] the other Area3D. - [code]area_shape[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]area_shape_index[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_entered"> @@ -160,27 +171,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> </signals> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 44e27643bb..d505ee98cc 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -44,83 +44,85 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Array" qualifiers="constructor"> + <constructors> + <constructor name="Array"> <return type="Array" /> <description> Constructs an empty [Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs an [Array] as a copy of the given [Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedByteArray" /> <description> Constructs an array from a [PackedByteArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedColorArray" /> <description> Constructs an array from a [PackedColorArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedFloat32Array" /> <description> Constructs an array from a [PackedFloat32Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedFloat64Array" /> <description> Constructs an array from a [PackedFloat64Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedInt32Array" /> <description> Constructs an array from a [PackedInt32Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedInt64Array" /> <description> Constructs an array from a [PackedInt64Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedStringArray" /> <description> Constructs an array from a [PackedStringArray]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedVector2Array" /> <description> Constructs an array from a [PackedVector2Array]. </description> - </method> - <method name="Array" qualifiers="constructor"> + </constructor> + <constructor name="Array"> <return type="Array" /> <argument index="0" name="from" type="PackedVector3Array" /> <description> Constructs an array from a [PackedVector3Array]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="void" /> <argument index="0" name="value" type="Variant" /> @@ -192,7 +194,7 @@ <return type="void" /> <argument index="0" name="value" type="Variant" /> <description> - Removes the first occurrence of a value from the array. To remove an element by index, use [method remove] instead. + Removes the first occurrence of a value from the array. To remove an element by index, use [method remove_at] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. [b]Note:[/b] On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed. </description> @@ -345,64 +347,6 @@ Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Array" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="void" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="pop_at"> <return type="Variant" /> <argument index="0" name="position" type="int" /> @@ -456,7 +400,7 @@ [/codeblock] </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="position" type="int" /> <description> @@ -530,18 +474,22 @@ <argument index="0" name="func" type="Callable" /> <description> Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array. - [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + [b]Note:[/b] You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [codeblocks] [gdscript] - class MyCustomSorter: - static func sort_ascending(a, b): - if a[0] < b[0]: - return true - return false + func sort_ascending(a, b): + if a[0] < b[0]: + return true + return false - var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] - my_items.sort_custom(MyCustomSorter.sort_ascending) - print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. + func _ready(): + var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]] + my_items.sort_custom(sort_ascending) + print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]]. + + # Descending, lambda version. + my_items.sort_custom(func(a, b): return a[0] > b[0]) + print(my_items) # Prints [[9, Rice], [5, Potato], [4, Tomato]]. [/gdscript] [csharp] // There is no custom sort support for Godot.Collections.Array @@ -550,4 +498,64 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="Array" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="void" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 49ce2588c5..c986947dfb 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -47,7 +47,7 @@ [b]Note:[/b] Godot uses clockwise [url=https://learnopengl.com/Advanced-OpenGL/Face-culling]winding order[/url] for front faces of triangle primitive modes. </description> <tutorials> - <link title="Procedural geometry using the ArrayMesh">https://docs.godotengine.org/en/latest/tutorials/content/procedural_geometry/arraymesh.html</link> + <link title="Procedural geometry using the ArrayMesh">$DOCS_URL/tutorials/3d/procedural_geometry/arraymesh.html</link> </tutorials> <methods> <method name="add_blend_shape"> diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 600ca93028..ed1cb789e0 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -9,7 +9,7 @@ By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. </description> <tutorials> - <link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> + <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> </tutorials> <members> <member name="drive" type="float" setter="set_drive" getter="get_drive" default="0.0"> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml index 5b43646077..4fb1c0e7c9 100644 --- a/doc/classes/AudioEffectFilter.xml +++ b/doc/classes/AudioEffectFilter.xml @@ -7,7 +7,7 @@ Allows frequencies other than the [member cutoff_hz] to pass. </description> <tutorials> - <link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> + <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> </tutorials> <members> <member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff" default="2000.0"> diff --git a/doc/classes/AudioEffectHighShelfFilter.xml b/doc/classes/AudioEffectHighShelfFilter.xml index c572824448..28498f6d8e 100644 --- a/doc/classes/AudioEffectHighShelfFilter.xml +++ b/doc/classes/AudioEffectHighShelfFilter.xml @@ -6,6 +6,6 @@ <description> </description> <tutorials> - <link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> + <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> </tutorials> </class> diff --git a/doc/classes/AudioEffectLowShelfFilter.xml b/doc/classes/AudioEffectLowShelfFilter.xml index e78dbf9732..4c839dc257 100644 --- a/doc/classes/AudioEffectLowShelfFilter.xml +++ b/doc/classes/AudioEffectLowShelfFilter.xml @@ -6,6 +6,6 @@ <description> </description> <tutorials> - <link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> + <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> </tutorials> </class> diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index b32206726d..0b6c5287cf 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -7,7 +7,7 @@ Allows the user to record sound from a microphone. It sets and gets the format in which the audio file will be recorded (8-bit, 16-bit, or compressed). It checks whether or not the recording is active, and if it is, records the sound. It then returns the recorded sample. </description> <tutorials> - <link title="Recording with microphone">https://docs.godotengine.org/en/latest/tutorials/audio/recording_with_microphone.html</link> + <link title="Recording with microphone">$DOCS_URL/tutorials/audio/recording_with_microphone.html</link> <link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link> </tutorials> <methods> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 66fa57cb52..b868cce077 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -7,7 +7,7 @@ [AudioServer] is a low-level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. </description> <tutorials> - <link title="Audio buses">https://docs.godotengine.org/en/latest/tutorials/audio/audio_buses.html</link> + <link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link> <link title="Audio Device Changer Demo">https://godotengine.org/asset-library/asset/525</link> <link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link> <link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link> diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index cff7199c4a..722ff802e7 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -7,7 +7,7 @@ Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamSample]) and OGG (via [AudioStreamOGGVorbis]) file formats. </description> <tutorials> - <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> + <link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link> <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link> <link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link> <link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index b692ae858e..d20aaff1e8 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -8,7 +8,7 @@ To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer]. </description> <tutorials> - <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> + <link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="Audio Device Changer Demo">https://godotengine.org/asset-library/asset/525</link> <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 9c76eefbf9..0ad161a6fe 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -9,7 +9,7 @@ [b]Note:[/b] Hiding an [AudioStreamPlayer2D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer2D]'s audio output, set [member volume_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing). </description> <tutorials> - <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> + <link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link> </tutorials> <methods> <method name="get_playback_position"> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index bd344fad29..ce8a6693db 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -10,7 +10,7 @@ [b]Note:[/b] Hiding an [AudioStreamPlayer3D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer3D]'s audio output, set [member unit_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing). </description> <tutorials> - <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> + <link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link> </tutorials> <methods> <method name="get_playback_position"> @@ -123,7 +123,7 @@ Logarithmic dampening of loudness according to distance. </constant> <constant name="ATTENUATION_DISABLED" value="3" enum="AttenuationModel"> - No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. + No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. [constant ATTENUATION_DISABLED] can be combined with a [member max_distance] value greater than [code]0.0[/code] to achieve linear attenuation clamped to a sphere of a defined size. </constant> <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> Disables doppler tracking. 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/BaseButton.xml b/doc/classes/BaseButton.xml index 889c703b07..981b3167d9 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -50,7 +50,7 @@ <member name="button_group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> The [ButtonGroup] associated with the button. Not to be confused with node groups. </member> - <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" default="1"> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButton" default="1"> Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use [code]MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT[/code]. </member> diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index a5516636aa..f0f49f89d5 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -7,7 +7,7 @@ This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details. </description> <tutorials> - <link title="Spatial material">https://docs.godotengine.org/en/latest/tutorials/3d/spatial_material.html</link> + <link title="Standard Material 3D">$DOCS_URL/tutorials/3d/standard_material_3d.html</link> </tutorials> <methods> <method name="get_feature" qualifiers="const"> @@ -232,7 +232,7 @@ </member> <member name="metallic_specular" type="float" setter="set_specular" getter="get_specular" default="0.5"> Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources. - [b]Note:[/b] unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness]. + [b]Note:[/b] Unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness]. </member> <member name="metallic_texture" type="Texture2D" setter="set_texture" getter="get_texture"> Texture used to specify metallic for an object. This is multiplied by [member metallic]. @@ -250,7 +250,8 @@ The strength of the normal map's effect. </member> <member name="normal_texture" type="Texture2D" setter="set_texture" getter="get_texture"> - Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh]. + Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh]. + [b]Note:[/b] The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with [SurfaceTool], you can use [method SurfaceTool.generate_normals] and [method SurfaceTool.generate_tangents] to automatically generate normals and tangents respectively. [b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines. </member> <member name="orm_texture" type="Texture2D" setter="set_texture" getter="get_texture"> @@ -351,7 +352,7 @@ </member> <member name="use_point_size" type="bool" setter="set_flag" getter="get_flag" default="false"> If [code]true[/code], render point size can be changed. - [b]Note:[/b] this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member point_size]. + [b]Note:[/b] This is only effective for objects whose geometry is point-based rather than triangle-based. See also [member point_size]. </member> <member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" default="Vector3(0, 0, 0)"> How much to offset the [code]UV[/code] coordinates. This amount will be added to [code]UV[/code] in the vertex function. This can be used to offset a texture. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 63df5c40b2..bf3d20c11c 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -10,52 +10,44 @@ For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Matrices and transforms">https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link> - <link title="Using 3D transforms">https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.html</link> + <link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.html</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Basis" qualifiers="constructor"> + <constructors> + <constructor name="Basis"> <return type="Basis" /> <description> Constructs a default-initialized [Basis] set to [constant IDENTITY]. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="from" type="Basis" /> <description> Constructs a [Basis] as a copy of the given [Basis]. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="axis" type="Vector3" /> <argument index="1" name="phi" type="float" /> <description> Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector. </description> - </method> - <method name="Basis" qualifiers="constructor"> - <return type="Basis" /> - <argument index="0" name="euler" type="Vector3" /> - <description> - Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). - Consider using the [Quaternion] constructor instead, which uses a quaternion instead of Euler angles. - </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="from" type="Quaternion" /> <description> Constructs a pure rotation basis matrix from the given quaternion. </description> - </method> - <method name="Basis" qualifiers="constructor"> + </constructor> + <constructor name="Basis"> <return type="Basis" /> <argument index="0" name="x_axis" type="Vector3" /> <argument index="1" name="y_axis" type="Vector3" /> @@ -63,7 +55,9 @@ <description> Constructs a basis matrix from 3 axis vectors (matrix columns). </description> - </method> + </constructor> + </constructors> + <methods> <method name="determinant" qualifiers="const"> <return type="float" /> <description> @@ -71,6 +65,13 @@ A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid. </description> </method> + <method name="from_euler" qualifiers="static"> + <return type="Basis" /> + <argument index="0" name="euler" type="Vector3" /> + <argument index="1" name="order" type="int" default="2" /> + <description> + </description> + </method> <method name="from_scale" qualifiers="static"> <return type="Basis" /> <argument index="0" name="scale" type="Vector3" /> @@ -80,6 +81,7 @@ </method> <method name="get_euler" qualifiers="const"> <return type="Vector3" /> + <argument index="0" name="order" type="int" default="2" /> <description> Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles. @@ -125,60 +127,6 @@ The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The [code]target[/code] and [code]up[/code] vectors cannot be zero, and cannot be parallel to each other. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Basis], which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Basis" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Basis], which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Basis" /> <description> @@ -248,6 +196,18 @@ </member> </members> <constants> + <constant name="EULER_ORDER_XYZ" value="0"> + </constant> + <constant name="EULER_ORDER_XZY" value="1"> + </constant> + <constant name="EULER_ORDER_YXZ" value="2"> + </constant> + <constant name="EULER_ORDER_YZX" value="3"> + </constant> + <constant name="EULER_ORDER_ZXY" value="4"> + </constant> + <constant name="EULER_ORDER_ZYX" value="5"> + </constant> <constant name="IDENTITY" value="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)"> The identity basis, with no rotation or scaling applied. This is identical to calling [code]Basis()[/code] without any parameters. This constant can be used to make your code clearer, and for consistency with C#. @@ -262,4 +222,67 @@ The basis that will flip something along the Z axis when used in a transformation. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Basis" /> + <description> + Returns [code]true[/code] if the [Basis] matrices are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="Basis" /> + <description> + Composes these two basis matrices by multiplying them together. This has the effect of transforming the second basis (the child) by the first basis (the parent). + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Transforms (multiplies) the [Vector3] by the given [Basis] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Basis], which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Basis" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Basis], which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Basis" /> + <description> + Returns [code]true[/code] if the [Basis] matrices are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator []"> + <return type="Vector3" /> + <argument index="0" name="index" type="int" /> + <description> + Access basis components using their index. [code]b[0][/code] is equivalent to [code]b.x[/code], [code]b[1][/code] is equivalent to [code]b.y[/code], and [code]b[2][/code] is equivalent to [code]b.z[/code]. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 0997896260..dc655ee3b0 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -48,7 +48,7 @@ <argument index="0" name="pixels" type="int" /> <argument index="1" name="rect" type="Rect2" /> <description> - Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied. + Applies morphological dilation or erosion to the bitmap. If [code]pixels[/code] is positive, dilation is applied to the bitmap. If [code]pixels[/code] is negative, erosion is applied to the bitmap. [code]rect[/code] defines the area where the morphological operation is applied. Pixels located outside the [code]rect[/code] are unaffected by [method grow_mask]. </description> </method> <method name="opaque_to_polygons" qualifiers="const"> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index dfbd6c0680..055d5091c7 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -78,6 +78,7 @@ </member> <member name="icon" type="Texture2D" setter="set_button_icon" getter="get_button_icon"> Button's icon, if text is present the icon will be placed before the text. + To edit margin and spacing of the icon, use [theme_item hseparation] theme property and [code]content_margin_*[/code] properties of the used [StyleBox]es. </member> <member name="icon_align" type="int" setter="set_icon_align" getter="get_icon_align" enum="Button.TextAlign" default="0"> Specifies if the icon should be aligned to the left, right, or center of a button. Uses the same [enum TextAlign] constants as the text alignment. If centered, text will draw on top of the icon. @@ -119,6 +120,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> Text [Color] used when the [Button] is disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + Text [Color] used when the [Button] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> Text [Color] used when the [Button] is being hovered. </theme_item> @@ -143,6 +147,9 @@ <theme_item name="icon_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> Icon modulate [Color] used when the [Button] is disabled. </theme_item> + <theme_item name="icon_focus_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> + Icon modulate [Color] used when the [Button] is focused. Only replaces the normal modulate color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="icon_hover_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> Icon modulate [Color] used when the [Button] is being hovered. </theme_item> diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 9226140c1a..0505d8ad36 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -8,7 +8,7 @@ See also [GPUParticles2D], which provides the same functionality with hardware acceleration, but may not run on older devices. </description> <tutorials> - <link title="Particle systems (2D)">https://docs.godotengine.org/en/latest/tutorials/2d/particle_systems_2d.html</link> + <link title="Particle systems (2D)">$DOCS_URL/tutorials/2d/particle_systems_2d.html</link> </tutorials> <methods> <method name="convert_from_particles"> 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/Callable.xml b/doc/classes/Callable.xml index 0a95836e96..2d3571e36c 100644 --- a/doc/classes/Callable.xml +++ b/doc/classes/Callable.xml @@ -35,28 +35,30 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Callable" qualifiers="constructor"> + <constructors> + <constructor name="Callable"> <return type="Callable" /> <description> Constructs a null [Callable] with no object nor method bound. </description> - </method> - <method name="Callable" qualifiers="constructor"> + </constructor> + <constructor name="Callable"> <return type="Callable" /> <argument index="0" name="from" type="Callable" /> <description> Constructs a [Callable] as a copy of the given [Callable]. </description> - </method> - <method name="Callable" qualifiers="constructor"> + </constructor> + <constructor name="Callable"> <return type="Callable" /> <argument index="0" name="object" type="Object" /> <argument index="1" name="method" type="StringName" /> <description> Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="bind" qualifiers="vararg const"> <return type="Callable" /> <description> @@ -123,30 +125,6 @@ Returns [code]true[/code] if the object exists and has a valid function assigned, or is a custom callable. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Callable" /> - <description> - Returns [code]true[/code] if both [Callable]s invoke different targets. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Callable" /> - <description> - Returns [code]true[/code] if both [Callable]s invoke the same custom target. - </description> - </method> <method name="rpc" qualifiers="vararg const"> <return type="void" /> <description> @@ -168,4 +146,30 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Callable" /> + <description> + Returns [code]true[/code] if both [Callable]s invoke different targets. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Callable" /> + <description> + Returns [code]true[/code] if both [Callable]s invoke the same custom target. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index cd17a31e23..772396befe 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -26,7 +26,7 @@ <method name="get_camera_transform" qualifiers="const"> <return type="Transform3D" /> <description> - Returns the transform of the camera plus the vertical ([member v_offset]) and horizontal ([member h_offset]) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as [ClippedCamera3D] and [XRCamera3D]. + Returns the transform of the camera plus the vertical ([member v_offset]) and horizontal ([member h_offset]) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as [XRCamera3D]. </description> </method> <method name="get_cull_mask_value" qualifiers="const"> @@ -42,6 +42,12 @@ Returns the camera's frustum planes in world space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset]. </description> </method> + <method name="get_pyramid_shape_rid"> + <return type="RID" /> + <description> + Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the camera's near plane. The tip of the pyramid represents the position of the camera. + </description> + </method> <method name="is_position_behind" qualifiers="const"> <return type="bool" /> <argument index="0" name="world_point" type="Vector3" /> @@ -212,10 +218,10 @@ Disables [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] simulation (default). </constant> <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking"> - Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's [member AudioStreamPlayer3D.pitch_scale]). </constant> <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking"> - Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]). + Simulate [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this camera compared to those objects affect how audio is perceived (changing the audio's [member AudioStreamPlayer3D.pitch_scale]). </constant> </constants> </class> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 501f89fa0d..98437ef296 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -12,8 +12,8 @@ [b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad]. </description> <tutorials> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> - <link title="Custom drawing in 2D">https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> + <link title="Custom drawing in 2D">$DOCS_URL/tutorials/2d/custom_drawing_in_2d.html</link> <link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link> </tutorials> <methods> @@ -53,7 +53,7 @@ <argument index="1" name="pos" type="Vector2" /> <argument index="2" name="char" type="String" /> <argument index="3" name="next" type="String" default="""" /> - <argument index="4" name="size" type="int" default="-1" /> + <argument index="4" name="size" type="int" default="16" /> <argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="6" name="outline_size" type="int" default="0" /> <argument index="7" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> @@ -146,11 +146,11 @@ <argument index="3" name="align" type="int" enum="HAlign" default="0" /> <argument index="4" name="width" type="float" default="-1" /> <argument index="5" name="max_lines" type="int" default="-1" /> - <argument index="6" name="size" type="int" default="-1" /> + <argument index="6" name="size" type="int" default="16" /> <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="8" name="outline_size" type="int" default="0" /> <argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> - <argument index="10" name="flags" type="int" default="51" /> + <argument index="10" name="flags" type="int" default="99" /> <description> Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. </description> @@ -238,7 +238,7 @@ <argument index="2" name="text" type="String" /> <argument index="3" name="align" type="int" enum="HAlign" default="0" /> <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="size" type="int" default="-1" /> + <argument index="5" name="size" type="int" default="16" /> <argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="7" name="outline_size" type="int" default="0" /> <argument index="8" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 2f99f94893..9ee5ce0dcb 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -7,8 +7,8 @@ Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). </description> <tutorials> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> - <link title="Canvas layers">https://docs.godotengine.org/en/latest/tutorials/2d/canvas_layers.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> + <link title="Canvas layers">$DOCS_URL/tutorials/2d/canvas_layers.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> </tutorials> <methods> diff --git a/doc/classes/CharFXTransform.xml b/doc/classes/CharFXTransform.xml index b00031edf6..d467c8a51d 100644 --- a/doc/classes/CharFXTransform.xml +++ b/doc/classes/CharFXTransform.xml @@ -7,7 +7,7 @@ By setting various properties on this object, you can control how individual characters will be displayed in a [RichTextEffect]. </description> <tutorials> - <link title="BBCode in RichTextLabel">https://docs.godotengine.org/en/latest/tutorials/gui/bbcode_in_richtextlabel.html</link> + <link title="BBCode in RichTextLabel">$DOCS_URL/tutorials/ui/bbcode_in_richtextlabel.html</link> <link title="RichTextEffect test project (third-party)">https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project</link> </tutorials> <members> @@ -15,7 +15,7 @@ The color the character will be drawn with. </member> <member name="elapsed_time" type="float" setter="set_elapsed_time" getter="get_elapsed_time" default="0.0"> - The time elapsed since the [RichTextLabel] was added to the scene tree (in seconds). Time stops when the project is paused depending on the value of the [RichTextLabel]'s [member Node.process_mode]. + The time elapsed since the [RichTextLabel] was added to the scene tree (in seconds). Time stops when the [RichTextLabel] is paused (see [member Node.process_mode]). Resets when the text in the [RichTextLabel] is changed. [b]Note:[/b] Time still passes while the [RichTextLabel] is hidden. </member> <member name="env" type="Dictionary" setter="set_environment" getter="get_environment" default="{}"> diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index e14c2dc110..0f573dcd66 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -9,8 +9,8 @@ [b]Kinematic motion:[/b] Character bodies can also be used for kinematic motion (same functionality as [AnimatableBody2D]), which allows them to be moved by code and push other bodies on their path. </description> <tutorials> - <link title="Kinematic character (2D)">https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> - <link title="Using KinematicBody2D">https://docs.godotengine.org/en/latest/tutorials/physics/using_kinematic_body_2d.html</link> + <link title="Kinematic character (2D)">$DOCS_URL/tutorials/physics/kinematic_character_2d.html</link> + <link title="Using KinematicBody2D">$DOCS_URL/tutorials/physics/using_kinematic_body_2d.html</link> <link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link> <link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link> </tutorials> diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 24b26fb16e..c70ce8acf9 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -9,7 +9,7 @@ [b]Kinematic motion:[/b] Character bodies can also be used for kinematic motion (same functionality as [AnimatableBody3D]), which allows them to be moved by code and push other bodies on their path. </description> <tutorials> - <link title="Kinematic character (2D)">https://docs.godotengine.org/en/latest/tutorials/physics/kinematic_character_2d.html</link> + <link title="Kinematic character (2D)">$DOCS_URL/tutorials/physics/kinematic_character_2d.html</link> <link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index a674fa8339..18f668a052 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -21,6 +21,7 @@ The check icon to display when the [CheckBox] is checked. </theme_item> <theme_item name="checked_disabled" data_type="icon" type="Texture2D"> + The check icon to display when the [CheckBox] is checked and disabled. </theme_item> <theme_item name="disabled" data_type="style" type="StyleBox"> The [StyleBox] to display as a background when the [CheckBox] is disabled. @@ -37,6 +38,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> The [CheckBox] text's font color when it's disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + The [CheckBox] text's font color when it's focused. Only replaces the normal text color of the checkbox. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> The [CheckBox] text's font color when it's hovered. </theme_item> @@ -84,6 +88,7 @@ The check icon to display when the [CheckBox] is unchecked. </theme_item> <theme_item name="unchecked_disabled" data_type="icon" type="Texture2D"> + The check icon to display when the [CheckBox] is unchecked and disabled. </theme_item> </theme_items> </class> diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml index 12bd493ae1..c86fadb6b0 100644 --- a/doc/classes/CheckButton.xml +++ b/doc/classes/CheckButton.xml @@ -32,6 +32,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> The [CheckButton] text's font color when it's disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + The [CheckButton] text's font color when it's focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> The [CheckButton] text's font color when it's hovered. </theme_item> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 5f39fc48e0..b4f98c6c5f 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -78,7 +78,7 @@ <argument index="1" name="no_inheritance" type="bool" default="false" /> <description> Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. - [b]Note:[/code] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. + [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. </description> </method> <method name="class_get_property" qualifiers="const"> diff --git a/doc/classes/ClippedCamera3D.xml b/doc/classes/ClippedCamera3D.xml deleted file mode 100644 index 1a0d3499cd..0000000000 --- a/doc/classes/ClippedCamera3D.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="ClippedCamera3D" inherits="Camera3D" version="4.0"> - <brief_description> - A [Camera3D] that includes collision. - </brief_description> - <description> - This node extends [Camera3D] to add collisions with [Area3D] and/or [PhysicsBody3D] nodes. The camera cannot move through colliding objects. - </description> - <tutorials> - </tutorials> - <methods> - <method name="add_exception"> - <return type="void" /> - <argument index="0" name="node" type="Object" /> - <description> - Adds a collision exception so the camera does not collide with the specified node. - </description> - </method> - <method name="add_exception_rid"> - <return type="void" /> - <argument index="0" name="rid" type="RID" /> - <description> - Adds a collision exception so the camera does not collide with the specified [RID]. - </description> - </method> - <method name="clear_exceptions"> - <return type="void" /> - <description> - Removes all collision exceptions. - </description> - </method> - <method name="get_clip_offset" qualifiers="const"> - <return type="float" /> - <description> - Returns the distance the camera has been offset due to a collision. - </description> - </method> - <method name="get_collision_mask_value" qualifiers="const"> - <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> - <description> - Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - </description> - </method> - <method name="remove_exception"> - <return type="void" /> - <argument index="0" name="node" type="Object" /> - <description> - Removes a collision exception with the specified node. - </description> - </method> - <method name="remove_exception_rid"> - <return type="void" /> - <argument index="0" name="rid" type="RID" /> - <description> - Removes a collision exception with the specified [RID]. - </description> - </method> - <method name="set_collision_mask_value"> - <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> - <description> - Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. - </description> - </method> - </methods> - <members> - <member name="clip_to_areas" type="bool" setter="set_clip_to_areas" getter="is_clip_to_areas_enabled" default="false"> - If [code]true[/code], the camera stops on contact with [Area3D]s. - </member> - <member name="clip_to_bodies" type="bool" setter="set_clip_to_bodies" getter="is_clip_to_bodies_enabled" default="true"> - If [code]true[/code], the camera stops on contact with [PhysicsBody3D]s. - </member> - <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The camera's collision mask. Only objects in at least one collision layer matching the mask will be 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="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> - The camera's collision margin. The camera can't get closer than this distance to a colliding object. - </member> - <member name="process_callback" type="int" setter="set_process_callback" getter="get_process_callback" enum="ClippedCamera3D.ClipProcessCallback" default="0"> - The camera's process callback. See [enum ClipProcessCallback]. - </member> - </members> - <constants> - <constant name="CLIP_PROCESS_PHYSICS" value="0" enum="ClipProcessCallback"> - The camera updates with the [code]_physics_process[/code] callback. - </constant> - <constant name="CLIP_PROCESS_IDLE" value="1" enum="ClipProcessCallback"> - The camera updates with the [code]_process[/code] callback. - </constant> - </constants> -</class> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index d856990ff8..bb1a4a79f0 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -5,7 +5,7 @@ </brief_description> <description> CodeEdit is a specialised [TextEdit] designed for editing plain text code files. It contains a bunch of features commonly found in code editors such as line numbers, line folding, code completion, indent management and string / comment management. - [b]Note[/b]: By default [CodeEdit] always use left-to-right text direction to correctly display source code. + [b]Note:[/b] By default [CodeEdit] always use left-to-right text direction to correctly display source code. </description> <tutorials> </tutorials> @@ -51,7 +51,7 @@ <argument index="5" name="value" type="Variant" default="0" /> <description> Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list. - [b]Note[/b]: This list will replace all current candidates. + [b]Note:[/b] This list will replace all current candidates. </description> </method> <method name="add_comment_delimiter"> @@ -431,7 +431,7 @@ <argument index="0" name="force" type="bool" /> <description> Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code]. - [b]Note[/b]: This will replace all current candidates. + [b]Note:[/b] This will replace all current candidates. </description> </method> </methods> @@ -494,7 +494,6 @@ <member name="line_length_guidelines" type="int[]" setter="set_line_length_guidelines" getter="get_line_length_guidelines" default="[]"> Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently </member> - <member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" override="true" default="[]" /> <member name="symbol_lookup_on_click" type="bool" setter="set_symbol_lookup_on_click_enabled" getter="is_symbol_lookup_on_click_enabled" default="false"> Set when a validated word from [signal symbol_validate] is clicked, the [signal symbol_lookup] should be emitted. </member> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index ba1ee3909d..63492bf9a0 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -198,11 +198,11 @@ <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="disable_mode" type="int" setter="set_disable_mode" getter="get_disable_mode" enum="CollisionObject2D.DisableMode" default="0"> Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. diff --git a/doc/classes/CollisionObject3D.xml b/doc/classes/CollisionObject3D.xml index 19bcdcbb27..33305471b8 100644 --- a/doc/classes/CollisionObject3D.xml +++ b/doc/classes/CollisionObject3D.xml @@ -170,11 +170,11 @@ <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> The physics layers this CollisionObject3D [b]is in[/b]. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The physics layers this CollisionObject3D [b]scans[/b]. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="disable_mode" type="int" setter="set_disable_mode" getter="get_disable_mode" enum="CollisionObject3D.DisableMode" default="0"> Defines the behavior in physics when [member Node.process_mode] is set to [constant Node.PROCESS_MODE_DISABLED]. See [enum DisableMode] for more details about the different modes. diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml index 5159b2b15b..c86bf18f24 100644 --- a/doc/classes/CollisionShape2D.xml +++ b/doc/classes/CollisionShape2D.xml @@ -7,7 +7,7 @@ Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject2D.shape_owner_get_shape] to get the actual shape. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="2D Pong Demo">https://godotengine.org/asset-library/asset/121</link> <link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link> diff --git a/doc/classes/CollisionShape3D.xml b/doc/classes/CollisionShape3D.xml index 84e362c38b..0f96d7c191 100644 --- a/doc/classes/CollisionShape3D.xml +++ b/doc/classes/CollisionShape3D.xml @@ -7,7 +7,7 @@ Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area3D] to give it a detection shape, or add it to a [PhysicsBody3D] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject3D.shape_owner_get_shape] to get the actual shape. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> <link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index c85bc775c7..22fb853b40 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -15,21 +15,14 @@ <link title="Tween Demo">https://godotengine.org/asset-library/asset/146</link> <link title="GUI Drag And Drop Demo">https://godotengine.org/asset-library/asset/133</link> </tutorials> - <methods> - <method name="Color" qualifiers="constructor"> + <constructors> + <constructor name="Color"> <return type="Color" /> <description> Constructs a default-initialized [Color] with all components set to [code]0[/code]. </description> - </method> - <method name="Color" qualifiers="constructor"> - <return type="Color" /> - <argument index="0" name="from" type="Color" /> - <description> - Constructs a [Color] as a copy of the given [Color]. - </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="from" type="Color" /> <argument index="1" name="alpha" type="float" /> @@ -44,57 +37,66 @@ [/csharp] [/codeblocks] </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> + <return type="Color" /> + <argument index="0" name="from" type="Color" /> + <description> + Constructs a [Color] as a copy of the given [Color]. + </description> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="code" type="String" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="code" type="String" /> <argument index="1" name="alpha" type="float" /> <description> Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants. </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="r" type="float" /> <argument index="1" name="g" type="float" /> <argument index="2" name="b" type="float" /> - <argument index="3" name="a" type="float" /> <description> - Constructs a [Color] from RGBA values, typically between 0 and 1. + Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. [codeblocks] [gdscript] - var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` + var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)` [/gdscript] [csharp] - var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` + var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)` [/csharp] [/codeblocks] </description> - </method> - <method name="Color" qualifiers="constructor"> + </constructor> + <constructor name="Color"> <return type="Color" /> <argument index="0" name="r" type="float" /> <argument index="1" name="g" type="float" /> <argument index="2" name="b" type="float" /> + <argument index="3" name="a" type="float" /> <description> - Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. + Constructs a [Color] from RGBA values, typically between 0 and 1. [codeblocks] [gdscript] - var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)` + var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)` [/gdscript] [csharp] - var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)` + var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)` [/csharp] [/codeblocks] </description> - </method> + </constructor> + </constructors> + <methods> <method name="blend" qualifiers="const"> <return type="Color" /> <argument index="0" name="over" type="Color" /> @@ -145,6 +147,24 @@ <description> </description> </method> + <method name="from_hsv" qualifiers="static"> + <return type="Color" /> + <argument index="0" name="h" type="float" /> + <argument index="1" name="s" type="float" /> + <argument index="2" name="v" type="float" /> + <argument index="3" name="alpha" type="float" default="1.0" /> + <description> + Constructs a color from an [url=https://en.wikipedia.org/wiki/HSL_and_HSV]HSV profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1. + [codeblocks] + [gdscript] + var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) + [/gdscript] + [csharp] + var c = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f); + [/csharp] + [/codeblocks] + </description> + </method> <method name="from_rgbe9995" qualifiers="static"> <return type="Color" /> <argument index="0" name="rgbe" type="int" /> @@ -259,92 +279,6 @@ [/codeblocks] </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Color" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Color" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Color" /> - <description> - </description> - </method> <method name="to_abgr32" qualifiers="const"> <return type="int" /> <description> @@ -937,4 +871,107 @@ Yellow green color. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Color" /> + <description> + Returns [code]true[/code] if the colors are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + Multiplies each component of the [Color] by the components of the given [Color]. + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies each component of the [Color] by the given [float]. + </description> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="int" /> + <description> + Multiplies each component of the [Color] by the given [int]. + </description> + </operator> + <operator name="operator +"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + Adds each component of the [Color] with the components of the given [Color]. + </description> + </operator> + <operator name="operator -"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + Subtracts each component of the [Color] by the components of the given [Color]. + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> + <description> + Divides each component of the [Color] by the components of the given [Color]. + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="float" /> + <description> + Divides each component of the [Color] by the given [float]. + </description> + </operator> + <operator name="operator /"> + <return type="Color" /> + <argument index="0" name="right" type="int" /> + <description> + Divides each component of the [Color] by the given [int]. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Color" /> + <description> + Returns [code]true[/code] if the colors are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + Access color components using their index. [code]c[0][/code] is equivalent to [code]c.r[/code], [code]c[1][/code] is equivalent to [code]c.g[/code], [code]c[2][/code] is equivalent to [code]c.b[/code], and [code]c[3][/code] is equivalent to [code]c.a[/code]. + </description> + </operator> + <operator name="operator unary+"> + <return type="Color" /> + <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. + </description> + </operator> + <operator name="operator unary-"> + <return type="Color" /> + <description> + Inverts the given color. This is equivalent to [code]Color.WHITE - c[/code] or [code]Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)[/code]. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index f33016cc6c..fca6a7631a 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -16,7 +16,7 @@ <argument index="0" name="color" type="Color" /> <description> Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. - [b]Note:[/b] the presets list is only for [i]this[/i] color picker. + [b]Note:[/b] The presets list is only for [i]this[/i] color picker. </description> </method> <method name="erase_preset"> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 1cdfbd760e..fff27d2d56 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -17,12 +17,14 @@ <return type="ColorPicker" /> <description> Returns the [ColorPicker] that this node toggles. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_popup"> <return type="PopupPanel" /> <description> Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> </methods> @@ -72,6 +74,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.3)"> Text [Color] used when the [ColorPickerButton] is disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> + Text [Color] used when the [ColorPickerButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> Text [Color] used when the [ColorPickerButton] is being hovered. </theme_item> diff --git a/doc/classes/ConcavePolygonShape3D.xml b/doc/classes/ConcavePolygonShape3D.xml index ac569a8992..fbbd0b4876 100644 --- a/doc/classes/ConcavePolygonShape3D.xml +++ b/doc/classes/ConcavePolygonShape3D.xml @@ -5,7 +5,7 @@ </brief_description> <description> Concave polygon shape resource, which can be set into a [PhysicsBody3D] or area. This shape is created by feeding a list of triangles. - Note: when used for collision, [ConcavePolygonShape3D] is intended to work with static [PhysicsBody3D] nodes like [StaticBody3D] and will not work with [CharacterBody3D] or [RigidDynamicBody3D] with a mode other than Static. + [b]Note:[/b] When used for collision, [ConcavePolygonShape3D] is intended to work with static [PhysicsBody3D] nodes like [StaticBody3D] and will not work with [CharacterBody3D] or [RigidDynamicBody3D] with a mode other than Static. </description> <tutorials> <link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 352631da1d..c4bdaf436d 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -22,6 +22,7 @@ <return type="Button" /> <description> Returns the cancel button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> </methods> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index e78eb8d259..24e73534d3 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -29,6 +29,11 @@ <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" override="true" enum="Control.MouseFilter" default="1" /> </members> <signals> + <signal name="pre_sort_children"> + <description> + Emitted when children are going to be sorted. + </description> + </signal> <signal name="sort_children"> <description> Emitted when sorting the children is needed. @@ -36,7 +41,10 @@ </signal> </signals> <constants> - <constant name="NOTIFICATION_SORT_CHILDREN" value="50"> + <constant name="NOTIFICATION_PRE_SORT_CHILDREN" value="50"> + Notification just before children are going to be sorted, in case there's something to process beforehand. + </constant> + <constant name="NOTIFICATION_SORT_CHILDREN" value="51"> Notification for when sorting the children, it must be obeyed immediately. </constant> </constants> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index c9a2de66a8..8739e0157d 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -16,9 +16,9 @@ [b]Note:[/b] Theme items are [i]not[/i] [Object] properties. This means you can't access their values using [method Object.get] and [method Object.set]. Instead, use the [code]get_theme_*[/code] and [code]add_theme_*_override[/code] methods provided by this class. </description> <tutorials> - <link title="GUI tutorial index">https://docs.godotengine.org/en/latest/tutorials/ui/index.html</link> - <link title="Custom drawing in 2D">https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link> - <link title="Control node gallery">https://docs.godotengine.org/en/latest/tutorials/ui/control_node_gallery.html</link> + <link title="GUI documentation index">$DOCS_URL/tutorials/ui/index.html</link> + <link title="Custom drawing in 2D">$DOCS_URL/tutorials/2d/custom_drawing_in_2d.html</link> + <link title="Control node gallery">$DOCS_URL/tutorials/ui/control_node_gallery.html</link> <link title="All GUI Demos">https://github.com/godotengine/godot-demo-projects/tree/master/gui</link> </tutorials> <methods> @@ -458,6 +458,27 @@ See [method get_theme_color] for details. </description> </method> + <method name="get_theme_default_base_scale" qualifiers="const"> + <return type="float" /> + <description> + Returns the default base scale value from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_base_scale] value. + See [method get_theme_color] for details. + </description> + </method> + <method name="get_theme_default_font" qualifiers="const"> + <return type="Font" /> + <description> + Returns the default font from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_font] value. + See [method get_theme_color] for details. + </description> + </method> + <method name="get_theme_default_font_size" qualifiers="const"> + <return type="int" /> + <description> + Returns the default font size value from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_font_size] value. + See [method get_theme_color] for details. + </description> + </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> <argument index="0" name="name" type="StringName" /> @@ -633,6 +654,12 @@ See [method add_theme_stylebox_override]. </description> </method> + <method name="is_drag_successful" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if drag operation is successful. + </description> + </method> <method name="is_layout_rtl" qualifiers="const"> <return type="bool" /> <description> @@ -693,6 +720,12 @@ Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock. </description> </method> + <method name="reset_size"> + <return type="void" /> + <description> + Resets the size to [method get_combined_minimum_size]. This is equivalent to calling [code]set_size(Vector2())[/code] (or any size below the minimum). + </description> + </method> <method name="set_anchor"> <return type="void" /> <argument index="0" name="side" type="int" enum="Side" /> @@ -742,10 +775,10 @@ </method> <method name="set_drag_forwarding"> <return type="void" /> - <argument index="0" name="target" type="Control" /> + <argument index="0" name="target" type="Object" /> <description> - Forwards the handling of this control's drag and drop to [code]target[/code] control. - Forwarding can be implemented in the target control similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: + Forwards the handling of this control's drag and drop to [code]target[/code] object. + Forwarding can be implemented in the target object similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: 1. The function name must be suffixed with [b]_fw[/b] 2. The function must take an extra argument that is the control doing the forwarding [codeblocks] @@ -1022,8 +1055,8 @@ </member> <member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2(1, 1)"> The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. The Control's [member hint_tooltip] will also scale according to this value. - [b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually. - [b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using [code]yield(get_tree(), "idle_frame")[/code] then set its [member rect_scale] property. + [b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=$DOCS_URL/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually. + [b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using [code]await get_tree().process_frame[/code] then set its [member rect_scale] property. </member> <member name="rect_size" type="Vector2" setter="_set_size" getter="get_size" default="Vector2(0, 0)"> The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically. diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index a87c8bfab2..04aee347e0 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -88,7 +88,7 @@ <argument index="1" name="ciphertext" type="PackedByteArray" /> <description> Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code]. - [b]Note[/b]: The maximum size of accepted ciphertext is limited by the key size. + [b]Note:[/b] The maximum size of accepted ciphertext is limited by the key size. </description> </method> <method name="encrypt"> @@ -97,7 +97,7 @@ <argument index="1" name="plaintext" type="PackedByteArray" /> <description> Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code]. - [b]Note[/b]: The maximum size of accepted plaintext is limited by the key size. + [b]Note:[/b] The maximum size of accepted plaintext is limited by the key size. </description> </method> <method name="generate_random_bytes"> diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index 5665c629a8..111da858ea 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -23,7 +23,7 @@ <argument index="1" name="public_only" type="bool" default="false" /> <description> Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. - [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. + [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. </description> </method> <method name="load_from_string"> @@ -40,7 +40,7 @@ <argument index="1" name="public_only" type="bool" default="false" /> <description> Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved. - [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. + [b]Note:[/b] [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. </description> </method> <method name="save_to_string"> diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 16e65eaadf..f98d8813c9 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -160,7 +160,7 @@ <argument index="0" name="udp_peer" type="PacketPeerUDP" /> <description> Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). - [b]Note[/b]: You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. + [b]Note:[/b] You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. </description> </method> </methods> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index adc1eab393..7218e3bcb0 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -177,24 +177,26 @@ [b]Note:[/b] When declaring a dictionary with [code]const[/code], the dictionary itself can still be mutated by defining the values of individual keys. Using [code]const[/code] will only prevent assigning the constant with another value after it was initialized. </description> <tutorials> - <link title="GDScript basics: Dictionary">https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_basics.html#dictionary</link> + <link title="GDScript basics: Dictionary">$DOCS_URL/tutorials/scripting/gdscript/gdscript_basics.html#dictionary</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> - <methods> - <method name="Dictionary" qualifiers="constructor"> + <constructors> + <constructor name="Dictionary"> <return type="Dictionary" /> <description> Constructs an empty [Dictionary]. </description> - </method> - <method name="Dictionary" qualifiers="constructor"> + </constructor> + <constructor name="Dictionary"> <return type="Dictionary" /> <argument index="0" name="from" type="Dictionary" /> <description> Constructs a [Dictionary] as a copy of the given [Dictionary]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="clear"> <return type="void" /> <description> @@ -288,45 +290,47 @@ Returns the list of keys in the [Dictionary]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="size" qualifiers="const"> + <return type="int" /> <description> + Returns the number of keys in the dictionary. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Dictionary" /> + <method name="values" qualifiers="const"> + <return type="Array" /> <description> + Returns the list of values in the [Dictionary]. </description> </method> - <method name="operator ==" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Dictionary" /> <description> </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Variant" /> - <argument index="0" name="key" type="Variant" /> + </operator> + <operator name="operator =="> + <return type="bool" /> <description> </description> - </method> - <method name="size" qualifiers="const"> - <return type="int" /> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Dictionary" /> <description> - Returns the number of keys in the dictionary. </description> - </method> - <method name="values" qualifiers="const"> - <return type="Array" /> + </operator> + <operator name="operator []"> + <return type="Variant" /> + <argument index="0" name="key" type="Variant" /> <description> - Returns the list of values in the [Dictionary]. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/DirectionalLight2D.xml b/doc/classes/DirectionalLight2D.xml index 317cf6e66c..1e5c9bc09a 100644 --- a/doc/classes/DirectionalLight2D.xml +++ b/doc/classes/DirectionalLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to the plane) to 1 (perpendicular to the plane). </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="10000.0"> </member> diff --git a/doc/classes/DirectionalLight3D.xml b/doc/classes/DirectionalLight3D.xml index 7c006ad3a6..661dbef07c 100644 --- a/doc/classes/DirectionalLight3D.xml +++ b/doc/classes/DirectionalLight3D.xml @@ -7,17 +7,17 @@ A directional light is a type of [Light3D] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight3D transform (origin) is ignored. Only the basis is used to determine light direction. </description> <tutorials> - <link title="Lights and shadows">https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> + <link title="Lights and shadows">$DOCS_URL/tutorials/3d/lights_and_shadows.html</link> </tutorials> <members> <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled" default="false"> - If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. + If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. Enabling shadow blend splitting also has a moderate performance cost. This is ignored when [member directional_shadow_mode] is [constant SHADOW_ORTHOGONAL]. </member> <member name="directional_shadow_fade_start" type="float" setter="set_param" getter="get_param" default="0.8"> - Proportion of [member directional_shadow_max_distance] at which point the shadow starts to fade. At [member directional_shadow_max_distance] the shadow will disappear. + Proportion of [member directional_shadow_max_distance] at which point the shadow starts to fade. At [member directional_shadow_max_distance], the shadow will disappear. The default value is a balance between smooth fading and distant shadow visibility. If the camera moves fast and the [member directional_shadow_max_distance] is low, consider lowering [member directional_shadow_fade_start] below [code]0.8[/code] to make shadow transitions less noticeable. On the other hand, if you tuned [member directional_shadow_max_distance] to cover the entire scene, you can set [member directional_shadow_fade_start] to [code]1.0[/code] to prevent the shadow from fading in the distance (it will suddenly cut off instead). </member> <member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param" default="100.0"> - The maximum distance for shadow splits. + The maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering). </member> <member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="DirectionalLight3D.ShadowMode" default="2"> The light's shadow rendering algorithm. See [enum ShadowMode]. @@ -26,13 +26,13 @@ Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to [code]0[/code] turns off the pancaking effect. </member> <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param" default="0.1"> - The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [constant SHADOW_PARALLEL_2_SPLITS] or [constant SHADOW_PARALLEL_4_SPLITS]. </member> <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param" default="0.2"> - The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_2_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code]. + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [constant SHADOW_PARALLEL_4_SPLITS]. </member> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param" default="0.5"> - The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code]. + The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [constant SHADOW_PARALLEL_4_SPLITS]. </member> <member name="shadow_bias" type="float" setter="set_param" getter="get_param" override="true" default="0.1" /> <member name="use_in_sky_only" type="bool" setter="set_sky_only" getter="is_sky_only" default="false"> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index c8fda27989..cd4b8fde1e 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -54,7 +54,7 @@ [/codeblocks] </description> <tutorials> - <link title="File system">https://docs.godotengine.org/en/latest/getting_started/step_by_step/filesystem.html</link> + <link title="File system">$DOCS_URL/tutorials/scripting/filesystem.html</link> </tutorials> <methods> <method name="change_dir"> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 4f495eaec9..1ca69057b4 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -10,12 +10,29 @@ <method name="clipboard_get" qualifiers="const"> <return type="String" /> <description> + Returns the user's clipboard as a string if possible. + </description> + </method> + <method name="clipboard_get_primary" qualifiers="const"> + <return type="String" /> + <description> + Returns the user's primary clipboard as a string if possible. + [b]Note:[/b] This method is only implemented on Linux. </description> </method> <method name="clipboard_set"> <return type="void" /> <argument index="0" name="clipboard" type="String" /> <description> + Sets the user's clipboard content to the given string. + </description> + </method> + <method name="clipboard_set_primary"> + <return type="void" /> + <argument index="0" name="clipboard_primary" type="String" /> + <description> + Sets the user's primary clipboard content to the given string. + [b]Note:[/b] This method is only implemented on Linux. </description> </method> <method name="console_set_visible"> @@ -276,6 +293,14 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> + <method name="keyboard_get_keycode_from_physical" qualifiers="const"> + <return type="int" enum="Key" /> + <argument index="0" name="keycode" type="int" enum="Key" /> + <description> + Converts a physical (US QWERTY) [code]keycode[/code] to one in the active keyboard layout. + [b]Note:[/b] This method is implemented on Linux, macOS and Windows. + </description> + </method> <method name="keyboard_get_layout_count" qualifiers="const"> <return type="int" /> <description> @@ -325,6 +350,7 @@ <method name="mouse_get_position" qualifiers="const"> <return type="Vector2i" /> <description> + Returns the mouse cursor's current position. </description> </method> <method name="mouse_set_mode"> @@ -337,6 +363,7 @@ <return type="void" /> <argument index="0" name="position" type="Vector2i" /> <description> + Sets the mouse cursor position to the given [code]position[/code]. </description> </method> <method name="process_events"> @@ -530,6 +557,7 @@ <argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" /> <argument index="1" name="window_id" type="int" default="0" /> <description> + Returns the current value of the given window's [code]flag[/code]. </description> </method> <method name="window_get_max_size" qualifiers="const"> @@ -548,12 +576,14 @@ <return type="int" enum="DisplayServer.WindowMode" /> <argument index="0" name="window_id" type="int" default="0" /> <description> + Returns the mode of the given window. </description> </method> <method name="window_get_position" qualifiers="const"> <return type="Vector2i" /> <argument index="0" name="window_id" type="int" default="0" /> <description> + Returns the position of the given window to on the screen. </description> </method> <method name="window_get_real_size" qualifiers="const"> @@ -607,6 +637,7 @@ <argument index="1" name="enabled" type="bool" /> <argument index="2" name="window_id" type="int" default="0" /> <description> + Enables or disables the given window's given [code]flag[/code]. See [enum WindowFlags] for possible values and their behavior. </description> </method> <method name="window_set_ime_active"> @@ -658,6 +689,8 @@ <argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode" /> <argument index="1" name="window_id" type="int" default="0" /> <description> + Sets window mode for the given window to [code]mode[/code]. See [enum WindowMode] for possible values and how each mode behaves. + [b]Note:[/b] Setting the window to fullscreen forcibly sets the borderless flag to [code]true[/code], so make sure to set it back to [code]false[/code] when not wanted. </description> </method> <method name="window_set_mouse_passthrough"> @@ -698,6 +731,7 @@ <argument index="0" name="position" type="Vector2i" /> <argument index="1" name="window_id" type="int" default="0" /> <description> + Sets the position of the given window to [code]position[/code]. </description> </method> <method name="window_set_rect_changed_callback"> @@ -712,6 +746,7 @@ <argument index="0" name="size" type="Vector2i" /> <argument index="1" name="window_id" type="int" default="0" /> <description> + Sets the size of the given window to [code]size[/code]. </description> </method> <method name="window_set_title"> @@ -719,6 +754,7 @@ <argument index="0" name="title" type="String" /> <argument index="1" name="window_id" type="int" default="0" /> <description> + Sets the title of the given window to [code]title[/code]. </description> </method> <method name="window_set_transient"> @@ -783,6 +819,8 @@ </constant> <constant name="FEATURE_SWAP_BUFFERS" value="17" enum="Feature"> </constant> + <constant name="FEATURE_CLIPBOARD_PRIMARY" value="19" enum="Feature"> + </constant> <constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode"> Makes the mouse cursor visible if it is hidden. </constant> @@ -863,7 +901,7 @@ </constant> <constant name="WINDOW_MODE_FULLSCREEN" value="3" enum="WindowMode"> Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project. - Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. + Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. </constant> <constant name="WINDOW_FLAG_RESIZE_DISABLED" value="0" enum="WindowFlags"> </constant> diff --git a/doc/classes/EditorDebuggerPlugin.xml b/doc/classes/EditorDebuggerPlugin.xml index 0773e176b3..6687d3c3ac 100644 --- a/doc/classes/EditorDebuggerPlugin.xml +++ b/doc/classes/EditorDebuggerPlugin.xml @@ -4,9 +4,10 @@ A base class to implement debugger plugins. </brief_description> <description> - All debugger plugin scripts must extend [EditorDebuggerPlugin]. It provides functions related to editor side of debugger. - You don't need to instantiate this class. That is handled by the debugger itself. [Control] nodes can be added as child nodes to provide a GUI front-end for the plugin. - Do not queue_free/reparent it's instance otherwise the instance becomes unusable. + [EditorDebuggerPlugin] provides functions related to the editor side of the debugger. + You don't need to instantiate this class; that is automatically handled by the debugger. [Control] nodes can be added as child nodes to provide a GUI for the plugin. + Do not free or reparent this node, otherwise it becomes unusable. + To use [EditorDebuggerPlugin], register it using the [method EditorPlugin.add_debugger_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index fca7bb350d..3830bfc60e 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -4,7 +4,8 @@ A script that is executed when exporting the project. </brief_description> <description> - Editor export plugins are automatically activated whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, [method _export_begin] is called at the beginning of the export process and then [method _export_file] is called for each exported file. + [EditorExportPlugin]s are automatically invoked whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, [method _export_begin] is called at the beginning of the export process and then [method _export_file] is called for each exported file. + To use [EditorExportPlugin], register it using the [method EditorPlugin.add_export_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 53fba9f3b8..79758281ac 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -26,6 +26,7 @@ <return type="VBoxContainer" /> <description> Returns the [code]VBoxContainer[/code] used to display the file system. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="invalidate"> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index f20f4adcdf..1f98781bbd 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -4,8 +4,8 @@ Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. </brief_description> <description> - EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your [EditorPlugin] with [method EditorPlugin.add_import_plugin]. - EditorImportPlugins work by associating with specific file extensions and a resource type. See [method _get_recognized_extensions] and [method _get_resource_type]. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].godot/imported[/code] directory. + [EditorImportPlugin]s provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. + EditorImportPlugins work by associating with specific file extensions and a resource type. See [method _get_recognized_extensions] and [method _get_resource_type]. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].godot/imported[/code] directory (see [member ProjectSettings.application/config/use_hidden_project_data_directory]). Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec": [codeblocks] [gdscript] @@ -108,14 +108,16 @@ } [/csharp] [/codeblocks] + To use [EditorImportPlugin], register it using the [method EditorPlugin.add_import_plugin] method first. </description> <tutorials> - <link title="Import plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/import_plugins.html</link> + <link title="Import plugins">$DOCS_URL/tutorials/plugins/editor/import_plugins.html</link> </tutorials> <methods> <method name="_get_import_options" qualifiers="virtual const"> <return type="Array" /> - <argument index="0" name="preset_index" type="int" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="preset_index" type="int" /> <description> Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). </description> @@ -134,8 +136,9 @@ </method> <method name="_get_option_visibility" qualifiers="virtual const"> <return type="bool" /> - <argument index="0" name="option_name" type="StringName" /> - <argument index="1" name="options" type="Dictionary" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="option_name" type="StringName" /> + <argument index="2" name="options" type="Dictionary" /> <description> This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: [codeblocks] @@ -197,7 +200,7 @@ <method name="_get_save_extension" qualifiers="virtual const"> <return type="String" /> <description> - Gets the extension used to save this resource in the [code].godot/imported[/code] directory. + Gets the extension used to save this resource in the [code].godot/imported[/code] directory (see [member ProjectSettings.application/config/use_hidden_project_data_directory]). </description> </method> <method name="_get_visible_name" qualifiers="virtual const"> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 17397b80bf..08f17cc5b2 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -4,16 +4,16 @@ Plugin for adding custom property editors on inspector. </brief_description> <description> - These plugins allow adding custom property editors to [EditorInspector]. - Plugins are registered via [method EditorPlugin.add_inspector_plugin]. + [EditorInspectorPlugin] allows adding custom property editors to [EditorInspector]. When an object is edited, the [method _can_handle] function is called and must return [code]true[/code] if the object type is supported. If supported, the function [method _parse_begin] will be called, allowing to place custom controls at the beginning of the class. Subsequently, the [method _parse_category] and [method _parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too. Finally, [method _parse_end] will be called. On each of these calls, the "add" functions can be called. + To use [EditorInspectorPlugin], register it using the [method EditorPlugin.add_inspector_plugin] method first. </description> <tutorials> - <link title="Inspector plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/inspector_plugins.html</link> + <link title="Inspector plugins">$DOCS_URL/tutorials/plugins/editor/inspector_plugins.html</link> </tutorials> <methods> <method name="_can_handle" qualifiers="virtual const"> @@ -25,8 +25,9 @@ </method> <method name="_parse_begin" qualifiers="virtual"> <return type="void" /> + <argument index="0" name="object" type="Object" /> <description> - Called to allow adding controls at the beginning of the list. + Called to allow adding controls at the beginning of the property list for [code]object[/code]. </description> </method> <method name="_parse_category" qualifiers="virtual"> @@ -34,12 +35,22 @@ <argument index="0" name="object" type="Object" /> <argument index="1" name="category" type="String" /> <description> + Called to allow adding controls at the beginning of a category in the property list for [code]object[/code]. </description> </method> <method name="_parse_end" qualifiers="virtual"> <return type="void" /> + <argument index="0" name="object" type="Object" /> + <description> + Called to allow adding controls at the end of the property list for [code]object[/code]. + </description> + </method> + <method name="_parse_group" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="object" type="Object" /> + <argument index="1" name="group" type="String" /> <description> - Called to allow adding controls at the end of the list. + Called to allow adding controls at the beginning of a group or a sub-group in the property list for [code]object[/code]. </description> </method> <method name="_parse_property" qualifiers="virtual"> @@ -52,7 +63,7 @@ <argument index="5" name="usage_flags" type="int" /> <argument index="6" name="wide" type="bool" /> <description> - Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. + Called to allow adding property-specific editors to the property list for [code]object[/code]. The added editor control must extend [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. </description> </method> <method name="add_custom_control"> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index ad878aad80..5790d8c5af 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -28,12 +28,14 @@ <return type="Control" /> <description> Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. + [b]Warning:[/b] Removing and freeing this node will render the editor useless and may cause a crash. </description> </method> <method name="get_command_palette" qualifiers="const"> <return type="EditorCommandPalette" /> <description> Returns the editor's [EditorCommandPalette] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_current_path" qualifiers="const"> @@ -53,6 +55,7 @@ <description> Returns the main editor control. Use this as a parent for main screens. [b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_editor_paths"> @@ -77,12 +80,14 @@ <return type="FileSystemDock" /> <description> Returns the editor's [FileSystemDock] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_inspector" qualifiers="const"> <return type="EditorInspector" /> <description> Returns the editor's [EditorInspector] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_open_scenes" qualifiers="const"> @@ -113,6 +118,7 @@ <return type="ScriptEditor" /> <description> Returns the editor's [ScriptEditor] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_selected_path" qualifiers="const"> diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index a2eac01ae8..c804bb70e0 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -178,7 +178,7 @@ </method> <method name="is_subgizmo_selected" qualifiers="const"> <return type="bool" /> - <argument index="0" name="arg0" type="int" /> + <argument index="0" name="id" type="int" /> <description> Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. </description> diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index 424d5dd310..3bcd9e7764 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -4,10 +4,11 @@ Used by the editor to define Node3D gizmo types. </brief_description> <description> - EditorNode3DGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending [EditorNode3DGizmoPlugin] for the simpler gizmos, or creating a new [EditorNode3DGizmo] type. See the tutorial in the documentation for more info. + [EditorNode3DGizmoPlugin] allows you to define a new type of Gizmo. There are two main ways to do so: extending [EditorNode3DGizmoPlugin] for the simpler gizmos, or creating a new [EditorNode3DGizmo] type. See the tutorial in the documentation for more info. + To use [EditorNode3DGizmoPlugin], register it using the [method EditorPlugin.add_spatial_gizmo_plugin] method first. </description> <tutorials> - <link title="Spatial gizmo plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/spatial_gizmos.html</link> + <link title="Spatial gizmo plugins">$DOCS_URL/tutorials/plugins/editor/spatial_gizmos.html</link> </tutorials> <methods> <method name="_can_be_hidden" qualifiers="virtual const"> diff --git a/doc/classes/EditorPaths.xml b/doc/classes/EditorPaths.xml index 92a2cff27f..c4d4c92afe 100644 --- a/doc/classes/EditorPaths.xml +++ b/doc/classes/EditorPaths.xml @@ -1,35 +1,65 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorPaths" inherits="Object" version="4.0"> <brief_description> + Editor-only singleton that returns paths to various OS-specific data folders and files. </brief_description> <description> + This editor-only singleton returns OS-specific paths to various data folders and files. It can be used in editor plugins to ensure files are saved in the correct location on each operating system. + [b]Note:[/b] This singleton is not accessible in exported projects. Attempting to access it in an exported project will result in a script error as the singleton won't be declared. To prevent script errors in exported projects, use [method Engine.has_singleton] to check whether the singleton is available before using it. + [b]Note:[/b] Godot complies with the [url=https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html]XDG Base Directory Specification[/url] on [i]all[/i] platforms. You can override environment variables following the specification to change the editor and project data paths. </description> <tutorials> + <link title="File paths in Godot projects">https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html</link> </tutorials> <methods> <method name="get_cache_dir" qualifiers="const"> <return type="String" /> <description> + Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails). + [b]Default paths per platform:[/b] + [codeblock] + - Windows: %LOCALAPPDATA%\Godot\ + - macOS: ~/Library/Caches/Godot/ + - Linux: ~/.cache/godot/ + [/codeblock] </description> </method> <method name="get_config_dir" qualifiers="const"> <return type="String" /> <description> + Returns the absolute path to the user's configuration folder. This folder should be used for [i]persistent[/i] user configuration files. + [b]Default paths per platform:[/b] + [codeblock] + - Windows: %APPDATA%\Godot\ (same as `get_data_dir()`) + - macOS: ~/Library/Application Support/Godot/ (same as `get_data_dir()`) + - Linux: ~/.config/godot/ + [/codeblock] </description> </method> <method name="get_data_dir" qualifiers="const"> <return type="String" /> <description> + Returns the absolute path to the user's data folder. This folder should be used for [i]persistent[/i] user data files such as installed export templates. + [b]Default paths per platform:[/b] + [codeblock] + - Windows: %APPDATA%\Godot\ (same as `get_config_dir()`) + - macOS: ~/Library/Application Support/Godot/ (same as `get_config_dir()`) + - Linux: ~/.local/share/godot/ + [/codeblock] </description> </method> <method name="get_self_contained_file" qualifiers="const"> <return type="String" /> <description> + Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also [method is_self_contained]. </description> </method> <method name="is_self_contained" qualifiers="const"> <return type="bool" /> <description> + Returns [code]true[/code] if the editor is marked as self-contained, [code]false[/code] otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an [code]editor_data/[/code] folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects. + Self-contained mode can be enabled by creating a file named [code]._sc_[/code] or [code]_sc_[/code] in the same folder as the editor binary while the editor is not running. See also [method get_self_contained_file]. + [b]Note:[/b] The Steam release of Godot uses self-contained mode by default. </description> </method> </methods> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index b8436be76a..7b0a300782 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -7,7 +7,7 @@ Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. See also [EditorScript] to add functions to the editor. </description> <tutorials> - <link title="Editor plugins tutorial index">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html</link> + <link title="Editor plugins documentation index">$DOCS_URL/tutorials/plugins/editor/index.html</link> </tutorials> <methods> <method name="_apply_changes" qualifiers="virtual"> @@ -96,7 +96,7 @@ </description> </method> <method name="_forward_3d_gui_input" qualifiers="virtual"> - <return type="bool" /> + <return type="int" /> <argument index="0" name="viewport_camera" type="Camera3D" /> <argument index="1" name="event" type="InputEvent" /> <description> @@ -105,13 +105,13 @@ [gdscript] # Prevents the InputEvent to reach other Editor classes. func _forward_3d_gui_input(camera, event): - return true + return EditorPlugin.AFTER_GUI_INPUT_STOP [/gdscript] [csharp] // Prevents the InputEvent to reach other Editor classes. public override bool _Forward3dGuiInput(Camera3D camera, InputEvent @event) { - return true; + return EditorPlugin.AFTER_GUI_INPUT_STOP; } [/csharp] [/codeblocks] @@ -185,12 +185,12 @@ Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblocks] [gdscript] - # Prevents the InputEvent to reach other Editor classes + # Prevents the InputEvent to reach other Editor classes. func _forward_canvas_gui_input(event): return true [/gdscript] [csharp] - // Prevents the InputEvent to reach other Editor classes + // Prevents the InputEvent to reach other Editor classes. public override bool ForwardCanvasGuiInput(InputEvent @event) { return true; @@ -202,13 +202,18 @@ [gdscript] # Consumes InputEventMouseMotion and forwards other InputEvent types. func _forward_canvas_gui_input(event): - return event is InputEventMouseMotion + if (event is InputEventMouseMotion): + return true + return false [/gdscript] [csharp] // Consumes InputEventMouseMotion and forwards other InputEvent types. public override bool ForwardCanvasGuiInput(InputEvent @event) { - return @event is InputEventMouseMotion; + if (@event is InputEventMouseMotion) { + return true; + } + return false } [/csharp] [/codeblocks] @@ -376,7 +381,7 @@ <argument index="0" name="importer" type="EditorImportPlugin" /> <description> Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. - [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_import_plugin] instead. + [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_format_importer_plugin] instead. See [method add_inspector_plugin] for an example of how to register a plugin. </description> </method> @@ -400,11 +405,18 @@ [/codeblocks] </description> </method> - <method name="add_scene_import_plugin"> + <method name="add_scene_format_importer_plugin"> + <return type="void" /> + <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <description> + Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. + </description> + </method> + <method name="add_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_importer" type="EditorSceneImporter" /> + <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> <description> - Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. + Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. </description> </method> <method name="add_spatial_gizmo_plugin"> @@ -457,6 +469,7 @@ <description> Gets the Editor's dialogue used for making scripts. [b]Note:[/b] Users can configure it before use. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_undo_redo"> @@ -548,11 +561,18 @@ Removes an inspector plugin registered by [method add_import_plugin] </description> </method> - <method name="remove_scene_import_plugin"> + <method name="remove_scene_format_importer_plugin"> + <return type="void" /> + <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <description> + Removes a scene format importer registered by [method add_scene_format_importer_plugin]. + </description> + </method> + <method name="remove_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_importer" type="EditorSceneImporter" /> + <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> <description> - Removes a scene importer registered by [method add_scene_import_plugin]. + Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. </description> </method> <method name="remove_spatial_gizmo_plugin"> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 6af6507606..5ae034c3ba 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -73,8 +73,8 @@ <member name="deletable" type="bool" setter="set_deletable" getter="is_deletable" default="false"> Used by the inspector, set to [code]true[/code] when the property can be deleted by the user. </member> - <member name="draw_red" type="bool" setter="set_draw_red" getter="is_draw_red" default="false"> - Used by the inspector, set to [code]true[/code] when the property must draw with error color. This is used for editable children's properties. + <member name="draw_warning" type="bool" setter="set_draw_warning" getter="is_draw_warning" default="false"> + Used by the inspector, set to [code]true[/code] when the property is drawn with the editor theme's warning color. This is used for editable children's properties. </member> <member name="keying" type="bool" setter="set_keying" getter="is_keying" default="false"> Used by the inspector, set to [code]true[/code] when the property can add keys for animation. @@ -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/EditorResourcePicker.xml b/doc/classes/EditorResourcePicker.xml index 9c490cbb3e..b26b6f9527 100644 --- a/doc/classes/EditorResourcePicker.xml +++ b/doc/classes/EditorResourcePicker.xml @@ -62,8 +62,9 @@ </signal> <signal name="resource_selected"> <argument index="0" name="resource" type="Resource" /> + <argument index="1" name="edit" type="bool" /> <description> - Emitted when the resource value was set and user clicked to edit it. + Emitted when the resource value was set and user clicked to edit it. When [code]edit[/code] is [code]true[/code], the signal was caused by the context menu "Edit" option. </description> </signal> </signals> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 4dc46945cf..c780045263 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -32,7 +32,7 @@ <argument index="3" name="userdata" type="Variant" /> <description> Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. - [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. + [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. </description> </method> <method name="queue_resource_preview"> @@ -43,7 +43,7 @@ <argument index="3" name="userdata" type="Variant" /> <description> Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. - [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. + [b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. </description> </method> <method name="remove_preview_generator"> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneFormatImporter.xml index a400db551f..5b5d6c4598 100644 --- a/doc/classes/EditorSceneImporter.xml +++ b/doc/classes/EditorSceneFormatImporter.xml @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporter" inherits="RefCounted" version="4.0"> +<class name="EditorSceneFormatImporter" inherits="RefCounted" version="4.0"> <brief_description> Imports scenes from third-parties' 3D files. </brief_description> <description> + [EditorSceneFormatImporter] allows to define an importer script for a third-party 3D format. + To use [EditorSceneFormatImporter], register it using the [method EditorPlugin.add_scene_format_importer_plugin] method first. </description> <tutorials> </tutorials> @@ -18,6 +20,19 @@ <description> </description> </method> + <method name="_get_import_options" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="path" type="String" /> + <description> + </description> + </method> + <method name="_get_option_visibility" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="option" type="String" /> + <description> + </description> + </method> <method name="_import_animation" qualifiers="virtual"> <return type="Animation" /> <argument index="0" name="path" type="String" /> diff --git a/doc/classes/EditorSceneFormatImporterFBX.xml b/doc/classes/EditorSceneFormatImporterFBX.xml new file mode 100644 index 0000000000..117030dfd5 --- /dev/null +++ b/doc/classes/EditorSceneFormatImporterFBX.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneFormatImporterFBX" inherits="EditorSceneFormatImporter" version="4.0"> + <brief_description> + FBX 3D asset importer. + </brief_description> + <description> + This is an FBX 3D asset importer with full support for most FBX features. + If exporting a FBX scene from Autodesk Maya, use these FBX export settings: + [codeblock] + - Smoothing Groups + - Smooth Mesh + - Triangluate (for meshes with blend shapes) + - Bake Animation + - Resample All + - Deformed Models + - Skins + - Blend Shapes + - Curve Filters + - Constant Key Reducer + - Auto Tangents Only + - *Do not check* Constraints (as it will break the file) + - Can check Embed Media (embeds textures into the exported FBX file) + - Note that when importing embedded media, the texture and mesh will be a single immutable file. + - You will have to re-export then re-import the FBX if the texture has changed. + - Units: Centimeters + - Up Axis: Y + - Binary format in FBX 2017 + [/codeblock] + </description> + <tutorials> + </tutorials> +</class> diff --git a/doc/classes/EditorSceneFormatImporterGLTF.xml b/doc/classes/EditorSceneFormatImporterGLTF.xml new file mode 100644 index 0000000000..1476a22aef --- /dev/null +++ b/doc/classes/EditorSceneFormatImporterGLTF.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneFormatImporterGLTF" inherits="EditorSceneFormatImporter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> +</class> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index 241531c35f..d90af6ed9e 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -52,7 +52,7 @@ [/codeblocks] </description> <tutorials> - <link title="Importing 3D scenes: Custom script">https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_scenes.html#custom-script</link> + <link title="Importing 3D scenes: Custom script">$DOCS_URL/tutorials/assets_pipeline/importing_scenes.html#custom-script</link> </tutorials> <methods> <method name="_post_import" qualifiers="virtual"> diff --git a/doc/classes/EditorScenePostImportPlugin.xml b/doc/classes/EditorScenePostImportPlugin.xml new file mode 100644 index 0000000000..904b22d9d3 --- /dev/null +++ b/doc/classes/EditorScenePostImportPlugin.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorScenePostImportPlugin" inherits="RefCounted" version="4.0"> + <brief_description> + Plugin to control and modifying the process of importing a scene. + </brief_description> + <description> + This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process. + </description> + <tutorials> + </tutorials> + <methods> + <method name="_get_import_options" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="path" type="String" /> + <description> + Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. + </description> + </method> + <method name="_get_internal_import_options" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="category" type="int" /> + <description> + Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced]. + </description> + </method> + <method name="_get_internal_option_update_view_required" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="option" type="String" /> + <description> + Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. + </description> + </method> + <method name="_get_internal_option_visibility" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="option" type="String" /> + <description> + Return true or false whether a given option should be visible. Return null to ignore. + </description> + </method> + <method name="_get_option_visibility" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="option" type="String" /> + <description> + Return true or false whether a given option should be visible. Return null to ignore. + </description> + </method> + <method name="_internal_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="base_node" type="Node" /> + <argument index="2" name="node" type="Node" /> + <argument index="3" name="resource" type="Resource" /> + <description> + Process a specific node or resource for a given category. + </description> + </method> + <method name="_post_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="scene" type="Node" /> + <description> + Post process the scene. This function is called after the final scene has been configured. + </description> + </method> + <method name="_pre_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="scene" type="Node" /> + <description> + Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. + </description> + </method> + <method name="add_import_option"> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="Variant" /> + <description> + Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. + </description> + </method> + <method name="add_import_option_advanced"> + <return type="void" /> + <argument index="0" name="type" type="int" enum="Variant.Type" /> + <argument index="1" name="name" type="String" /> + <argument index="2" name="default_value" type="Variant" /> + <argument index="3" name="hint" type="int" enum="PropertyHint" default="0" /> + <argument index="4" name="hint_string" type="String" default="""" /> + <argument index="5" name="usage_flags" type="int" default="7" /> + <description> + Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. + </description> + </method> + <method name="get_option_value" qualifiers="const"> + <return type="Variant" /> + <argument index="0" name="name" type="StringName" /> + <description> + Query the value of an option. This function can only be called from those querying visibility, or processing. + </description> + </method> + </methods> + <constants> + <constant name="INTERNAL_IMPORT_CATEGORY_NODE" value="0" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE" value="1" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MESH" value="2" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MATERIAL" value="3" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION" value="4" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE" value="5" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MAX" value="6" enum="InternalImportCategory"> + </constant> + </constants> +</class> diff --git a/doc/classes/EditorSyntaxHighlighter.xml b/doc/classes/EditorSyntaxHighlighter.xml index 8880ce4d44..462323a067 100644 --- a/doc/classes/EditorSyntaxHighlighter.xml +++ b/doc/classes/EditorSyntaxHighlighter.xml @@ -5,7 +5,7 @@ </brief_description> <description> Base syntax highlighter resource all editor syntax highlighters extend from, it is used in the [ScriptEditor]. - Add a syntax highlighter to an individual script by calling ScriptEditorBase._add_syntax_highlighter (currently not working). To apply to all scripts on open, call [method ScriptEditor.register_syntax_highlighter] + Add a syntax highlighter to an individual script by calling [method ScriptEditorBase.add_syntax_highlighter]. To apply to all scripts on open, call [method ScriptEditor.register_syntax_highlighter] </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorTranslationParserPlugin.xml b/doc/classes/EditorTranslationParserPlugin.xml index de8204def3..900d877f12 100644 --- a/doc/classes/EditorTranslationParserPlugin.xml +++ b/doc/classes/EditorTranslationParserPlugin.xml @@ -4,7 +4,7 @@ Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.). </brief_description> <description> - Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method _parse_file] method in script. + [EditorTranslationParserPlugin] is invoked when a file is being parsed to extract strings that require translation. To define the parsing and string extraction logic, override the [method _parse_file] method in script. Add the extracted strings to argument [code]msgids[/code] or [code]msgids_context_plural[/code] if context or plural is used. When adding to [code]msgids_context_plural[/code], you must add the data using the format [code]["A", "B", "C"][/code], where [code]A[/code] represents the extracted string, [code]B[/code] represents the context, and [code]C[/code] represents the plural version of the extracted string. If you want to add only context but not plural, put [code]""[/code] for the plural slot. The idea is the same if you only want to add plural but not context. See the code below for concrete examples. The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu. @@ -98,6 +98,7 @@ } [/csharp] [/codeblocks] + To use [EditorTranslationParserPlugin], register it using the [method EditorPlugin.add_translation_parser_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index f05a216301..9756b26dee 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -157,7 +157,7 @@ else: simulate_physics() [/codeblock] - See [url=https://docs.godotengine.org/en/latest/tutorials/plugins/running_code_in_the_editor.html]Running code in the editor[/url] in the documentation for more information. + See [url=$DOCS_URL/tutorials/plugins/running_code_in_the_editor.html]Running code in the editor[/url] in the documentation for more information. [b]Note:[/b] To detect whether the script is run from an editor [i]build[/i] (e.g. when pressing [kbd]F5[/kbd]), use [method OS.has_feature] with the [code]"editor"[/code] argument instead. [code]OS.has_feature("editor")[/code] will evaluate to [code]true[/code] both when the code is running in the editor and when running the project from the editor, but it will evaluate to [code]false[/code] when the code is run from an exported project. </description> </method> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 2c4e5ea886..c3d1dc4ab6 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -11,8 +11,8 @@ - Adjustments </description> <tutorials> - <link title="Environment and post-processing">https://docs.godotengine.org/en/latest/tutorials/3d/environment_and_post_processing.html</link> - <link title="Light transport in game engines">https://docs.godotengine.org/en/latest/tutorials/3d/high_dynamic_range.html</link> + <link title="Environment and post-processing">$DOCS_URL/tutorials/3d/environment_and_post_processing.html</link> + <link title="Light transport in game engines">$DOCS_URL/tutorials/3d/high_dynamic_range.html</link> <link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link> <link title="2D HDR Demo">https://godotengine.org/asset-library/asset/110</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> @@ -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]. @@ -56,8 +56,6 @@ <member name="ambient_light_energy" type="float" setter="set_ambient_light_energy" getter="get_ambient_light_energy" default="1.0"> The ambient light's energy. The higher the value, the stronger the light. </member> - <member name="ambient_light_occlusion_color" type="Color" setter="set_ao_color" getter="get_ao_color" default="Color(0, 0, 0, 1)"> - </member> <member name="ambient_light_sky_contribution" type="float" setter="set_ambient_light_sky_contribution" getter="get_ambient_light_sky_contribution" default="1.0"> Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. </member> @@ -103,8 +101,10 @@ If [code]true[/code], fog effects are enabled. </member> <member name="fog_height" type="float" setter="set_fog_height" getter="get_fog_height" default="0.0"> + The height at which the height fog effect begins. </member> <member name="fog_height_density" type="float" setter="set_fog_height_density" getter="get_fog_height_density" default="0.0"> + The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value. </member> <member name="fog_light_color" type="Color" setter="set_fog_light_color" getter="get_fog_light_color" default="Color(0.5, 0.6, 0.7, 1)"> </member> @@ -128,10 +128,10 @@ The bleed scale of the HDR glow. </member> <member name="glow_hdr_threshold" type="float" setter="set_glow_hdr_bleed_threshold" getter="get_glow_hdr_bleed_threshold" default="1.0"> - The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn't support HDR), this needs to be below [code]1.0[/code] for glow to be visible. A value of [code]0.9[/code] works well in this case. + The lower threshold of the HDR glow. When using the OpenGL renderer (which doesn't support HDR), this needs to be below [code]1.0[/code] for glow to be visible. A value of [code]0.9[/code] works well in this case. </member> <member name="glow_intensity" type="float" setter="set_glow_intensity" getter="get_glow_intensity" default="0.8"> - The overall brightness multiplier of the glow effect. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. + The overall brightness multiplier of the glow effect. When using the OpenGL renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering. </member> <member name="glow_levels/1" type="float" setter="set_glow_level" getter="get_glow_level" default="0.0"> The intensity of the 1st level of glow. This is the most "local" level (least blurry). @@ -160,7 +160,7 @@ If [code]true[/code], glow levels will be normalized so that summed together their intensities equal [code]1.0[/code]. </member> <member name="glow_strength" type="float" setter="set_glow_strength" getter="get_glow_strength" default="1.0"> - The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. + The strength of the glow effect. This applies as the glow is blurred across the screen and increases the distance and intensity of the blur. When using the OpenGL renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering. </member> <member name="reflected_light_source" type="int" setter="set_reflection_source" getter="get_reflection_source" enum="Environment.ReflectionSource" default="0"> </member> @@ -171,7 +171,8 @@ <member name="sdfgi_cascades" type="int" setter="set_sdfgi_cascades" getter="get_sdfgi_cascades" enum="Environment.SDFGICascades" default="1"> </member> <member name="sdfgi_enabled" type="bool" setter="set_sdfgi_enabled" getter="is_sdfgi_enabled" default="false"> - If [code]true[/code], enables signed distance field global illumination. + If [code]true[/code], enables signed distance field global illumination for meshes that have their [member GeometryInstance3D.gi_mode] set to [constant GeometryInstance3D.GI_MODE_BAKED]. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not. + [b]Performance:[/b] SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider [LightmapGI] instead). To improve SDFGI performance, enable [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution] in the Project Settings. [b]Note:[/b] Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. </member> <member name="sdfgi_energy" type="float" setter="set_sdfgi_energy" getter="get_sdfgi_energy" default="1.0"> @@ -204,10 +205,10 @@ If [code]true[/code], screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from [VoxelGI]s or [ReflectionProbe]s, but are slower and can't reflect surfaces occluded by others. </member> <member name="ss_reflections_fade_in" type="float" setter="set_ssr_fade_in" getter="get_ssr_fade_in" default="0.15"> - The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection). + The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection). Only positive values are valid (negative values will be clamped to [code]0.0[/code]). </member> <member name="ss_reflections_fade_out" type="float" setter="set_ssr_fade_out" getter="get_ssr_fade_out" default="2.0"> - The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection. + The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection. Only positive values are valid (negative values will be clamped to [code]0.0[/code]). </member> <member name="ss_reflections_max_steps" type="int" setter="set_ssr_max_steps" getter="get_ssr_max_steps" default="64"> The maximum number of steps for screen-space reflections. Higher values are slower. @@ -248,23 +249,41 @@ <member name="tonemap_white" type="float" setter="set_tonemap_white" getter="get_tonemap_white" default="1.0"> The white reference value for tonemapping. Only effective if the [member tonemap_mode] isn't set to [constant TONE_MAPPER_LINEAR]. </member> - <member name="volumetric_fog_density" type="float" setter="set_volumetric_fog_density" getter="get_volumetric_fog_density" default="0.01"> + <member name="volumetric_fog_albedo" type="Color" setter="set_volumetric_fog_albedo" getter="get_volumetric_fog_albedo" default="Color(1, 1, 1, 1)"> + The [Color] of the volumetric fog when interacting with lights. Mist and fog have an albedo close to [code]Color(1, 1, 1, 1)[/code] while smoke has a darker albedo. + </member> + <member name="volumetric_fog_ambient_inject" type="float" setter="set_volumetric_fog_ambient_inject" getter="get_volumetric_fog_ambient_inject" default="0.0"> + Scales the strength of ambient light used in the volumetric fog. A value of [code]0[/code] means that ambient light will not impact the volumetric fog. + </member> + <member name="volumetric_fog_anisotropy" type="float" setter="set_volumetric_fog_anisotropy" getter="get_volumetric_fog_anisotropy" default="0.2"> + The direction of scattered light as it goes through the volumetric fog. A value close [code]1[/code] means almost all light is scattered forward. A value close to [code]0[/code] means light is scattered equally in all directions. A value close to [code]-1[/code] means light is scattered mostly backward. Fog and mist scatter light slightly forward, while smoke scatters light equally in all directions. + </member> + <member name="volumetric_fog_density" type="float" setter="set_volumetric_fog_density" getter="get_volumetric_fog_density" default="0.05"> + The base density of the volumetric fog. Set this to the lowest density you want to have globally. </member> <member name="volumetric_fog_detail_spread" type="float" setter="set_volumetric_fog_detail_spread" getter="get_volumetric_fog_detail_spread" default="2.0"> + The distribution of size down the length of the froxel buffer. A higher value compresses the froxels closer to the camera and places more detail closer to the camera. + </member> + <member name="volumetric_fog_emission" type="Color" setter="set_volumetric_fog_emission" getter="get_volumetric_fog_emission" default="Color(0, 0, 0, 1)"> + The emitted light from the volumetric fog. Even with emission, volumetric fog will not cast light onto other surfaces. Emission is useful to establish an ambient color. As the volumetric fog effect uses single-scattering only, fog tends to need a little bit of emission to soften the harsh shadows. + </member> + <member name="volumetric_fog_emission_energy" type="float" setter="set_volumetric_fog_emission_energy" getter="get_volumetric_fog_emission_energy" default="1.0"> + The brightness of the emitted light from the volumetric fog. </member> <member name="volumetric_fog_enabled" type="bool" setter="set_volumetric_fog_enabled" getter="is_volumetric_fog_enabled" default="false"> + Enables the volumetric fog effect. Volumetric fog uses a screen-aligned froxel buffer to calculate accurate volumetric scattering in the short to medium range. Volumetric fog interacts with [FogVolume]s and lights to calculate localized and global fog. Volumetric fog uses a PBR single-scattering model based on extinction, scattering, and emission which it exposes to users as density, albedo, and emission. </member> <member name="volumetric_fog_gi_inject" type="float" setter="set_volumetric_fog_gi_inject" getter="get_volumetric_fog_gi_inject" default="0.0"> + Scales the strength of Global Illumination used in the volumetric fog. A value of [code]0[/code] means that Global Illumination will not impact the volumetric fog. </member> <member name="volumetric_fog_length" type="float" setter="set_volumetric_fog_length" getter="get_volumetric_fog_length" default="64.0"> - </member> - <member name="volumetric_fog_light" type="Color" setter="set_volumetric_fog_light" getter="get_volumetric_fog_light" default="Color(0, 0, 0, 1)"> - </member> - <member name="volumetric_fog_light_energy" type="float" setter="set_volumetric_fog_light_energy" getter="get_volumetric_fog_light_energy" default="1.0"> + The distance over which the volumetric fog is computed. Increase to compute fog over a greater range, decrease to add more detail when a long range is not needed. For best quality fog, keep this as low as possible. </member> <member name="volumetric_fog_temporal_reprojection_amount" type="float" setter="set_volumetric_fog_temporal_reprojection_amount" getter="get_volumetric_fog_temporal_reprojection_amount" default="0.9"> + The amount by which to blend the last frame with the current frame. A higher number results in smoother volumetric fog, but makes "ghosting" much worse. A lower value reduces ghosting but can result in the per-frame temporal jitter becoming visible. </member> <member name="volumetric_fog_temporal_reprojection_enabled" type="bool" setter="set_volumetric_fog_temporal_reprojection_enabled" getter="is_volumetric_fog_temporal_reprojection_enabled" default="true"> + Enables temporal reprojection in the volumetric fog. Temporal reprojection blends the current frame's volumetric fog with the last frame's volumetric fog to smooth out jagged edges. The performance cost is minimal, however it does lead to moving [FogVolume]s and [Light3D]s "ghosting" and leaving a trail behind them. When temporal reprojection is enabled, try to avoid moving [FogVolume]s or [Light3D]s too fast. </member> </members> <constants> @@ -349,13 +368,5 @@ </constant> <constant name="SDFGI_Y_SCALE_50_PERCENT" value="2" enum="SDFGIYScale"> </constant> - <constant name="VOLUMETRIC_FOG_SHADOW_FILTER_DISABLED" value="0" enum="VolumetricFogShadowFilter"> - </constant> - <constant name="VOLUMETRIC_FOG_SHADOW_FILTER_LOW" value="1" enum="VolumetricFogShadowFilter"> - </constant> - <constant name="VOLUMETRIC_FOG_SHADOW_FILTER_MEDIUM" value="2" enum="VolumetricFogShadowFilter"> - </constant> - <constant name="VOLUMETRIC_FOG_SHADOW_FILTER_HIGH" value="3" enum="VolumetricFogShadowFilter"> - </constant> </constants> </class> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index cf08029c72..276c1f0223 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -40,12 +40,12 @@ } [/csharp] [/codeblocks] - In the example above, the file will be saved in the user data folder as specified in the [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] documentation. + In the example above, the file will be saved in the user data folder as specified in the [url=$DOCS_URL/tutorials/io/data_paths.html]Data paths[/url] documentation. [b]Note:[/b] To access project resources once exported, it is recommended to use [ResourceLoader] instead of the [File] API, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package. [b]Note:[/b] Files are automatically closed only if the process exits "normally" (such as by clicking the window manager's close button or pressing [b]Alt + F4[/b]). If you stop the project execution by pressing [b]F8[/b] while the project is running, the file won't be closed as the game process will be killed. You can work around this by calling [method flush] at regular intervals. </description> <tutorials> - <link title="File system">https://docs.godotengine.org/en/latest/getting_started/step_by_step/filesystem.html</link> + <link title="File system">$DOCS_URL/tutorials/scripting/filesystem.html</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <methods> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 22b5c72fa9..fa43f97104 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -32,12 +32,14 @@ <return type="LineEdit" /> <description> Returns the LineEdit for the selected file. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_vbox"> <return type="VBoxContainer" /> <description> Returns the vertical box container of the dialog, custom controls can be added to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="invalidate"> diff --git a/doc/classes/FogMaterial.xml b/doc/classes/FogMaterial.xml new file mode 100644 index 0000000000..431f3ac2b7 --- /dev/null +++ b/doc/classes/FogMaterial.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="FogMaterial" inherits="Material" version="4.0"> + <brief_description> + [Material] used with a [FogVolume] to draw things with the volumetric fog effect. + </brief_description> + <description> + A [Material] resource that can be used by [FogVolume]s to draw volumetric effects. + </description> + <tutorials> + </tutorials> + <members> + <member name="albedo" type="Color" setter="set_albedo" getter="get_albedo" default="Color(1, 1, 1, 1)"> + Sets the single-scattering [Color] of the [FogVolume]. Internally [member albedo] is converted into single-scattering which is additively blended with other [FogVolume]s and the [member Environment.volumetric_fog_albedo]. + </member> + <member name="density" type="float" setter="set_density" getter="get_density" default="1.0"> + Sets the density of the [FogVolume]. Denser objects are more opaque, but may suffer from under-sampling artifacts that look like stripes. + </member> + <member name="density_texture" type="Texture3D" setter="set_density_texture" getter="get_density_texture"> + Sets a 3D texture that is used to scale the [member density] of the [FogVolume]. + </member> + <member name="edge_fade" type="float" setter="set_edge_fade" getter="get_edge_fade" default="0.1"> + Sets the hardness of the edges of the [FogVolume]. A higher number will result in softer edges while a lower number will result in harder edges. + </member> + <member name="emission" type="Color" setter="set_emission" getter="get_emission" default="Color(0, 0, 0, 1)"> + Sets the [Color] of the light emitted by the [FogVolume]. Emitted light will not cast light or shadows on other objects, but can be useful for modulating the [Color] of the [FogVolume] independently from light sources. + </member> + <member name="height_falloff" type="float" setter="set_height_falloff" getter="get_height_falloff" default="0.0"> + Sets the rate by which the height-based fog decreases in density as height increases in world space. A high falloff will result in a sharp transition, while a low falloff will result in a smoother transition. A value of [code]0[/code] results in uniform-density fog. The height threshold is determined by the height of the associated [FogVolume]. + </member> + </members> +</class> diff --git a/doc/classes/FogVolume.xml b/doc/classes/FogVolume.xml new file mode 100644 index 0000000000..ba1b5d3372 --- /dev/null +++ b/doc/classes/FogVolume.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="FogVolume" inherits="VisualInstance3D" version="4.0"> + <brief_description> + A node used to add local fog with the volumetric fog effect. + </brief_description> + <description> + [FogVolume]s are used to add localized fog into the global volumetric fog effect. + Performance of [FogVolume]s is directly related to their relative size on the screen and the complexity of their attached [FogMaterial]. It is best to keep [FogVolume]s relatively small and simple where possible. + </description> + <tutorials> + </tutorials> + <members> + <member name="extents" type="Vector3" setter="set_extents" getter="get_extents" default="Vector3(1, 1, 1)"> + Sets the size of the [FogVolume] when [member shape] is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX]. + </member> + <member name="material" type="Material" setter="set_material" getter="get_material"> + Sets the [Material] to be used by the [FogVolume]. Can be either a [FogMaterial] or a custom [ShaderMaterial]. + </member> + <member name="shape" type="int" setter="set_shape" getter="get_shape" enum="RenderingServer.FogVolumeShape" default="1"> + Sets the shape of the [FogVolume] to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX], or [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD]. + </member> + </members> +</class> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index e8ff0f60ec..01bc2837f1 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -82,7 +82,7 @@ <argument index="1" name="pos" type="Vector2" /> <argument index="2" name="char" type="int" /> <argument index="3" name="next" type="int" default="0" /> - <argument index="4" name="size" type="int" default="-1" /> + <argument index="4" name="size" type="int" default="16" /> <argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="6" name="outline_size" type="int" default="0" /> <argument index="7" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> @@ -99,11 +99,11 @@ <argument index="3" name="align" type="int" enum="HAlign" default="0" /> <argument index="4" name="width" type="float" default="-1" /> <argument index="5" name="max_lines" type="int" default="-1" /> - <argument index="6" name="size" type="int" default="-1" /> + <argument index="6" name="size" type="int" default="16" /> <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="8" name="outline_size" type="int" default="0" /> <argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> - <argument index="10" name="flags" type="int" default="51" /> + <argument index="10" name="flags" type="int" default="99" /> <description> Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws it into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string]. @@ -116,7 +116,7 @@ <argument index="2" name="text" type="String" /> <argument index="3" name="align" type="int" enum="HAlign" default="0" /> <argument index="4" name="width" type="float" default="-1" /> - <argument index="5" name="size" type="int" default="-1" /> + <argument index="5" name="size" type="int" default="16" /> <argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="7" name="outline_size" type="int" default="0" /> <argument index="8" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> @@ -128,7 +128,7 @@ </method> <method name="get_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="size" type="int" default="-1" /> + <argument index="0" name="size" type="int" default="16" /> <description> Returns the average font ascent (number of pixels above the baseline). [b]Note:[/b] Real ascent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the ascent of empty line). @@ -138,7 +138,7 @@ <return type="Vector2" /> <argument index="0" name="char" type="int" /> <argument index="1" name="next" type="int" default="0" /> - <argument index="2" name="size" type="int" default="-1" /> + <argument index="2" name="size" type="int" default="16" /> <description> Returns the size of a character, optionally taking kerning into account if the next character is provided. [b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height. @@ -166,7 +166,7 @@ </method> <method name="get_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="size" type="int" default="-1" /> + <argument index="0" name="size" type="int" default="16" /> <description> Returns the average font descent (number of pixels below the baseline). [b]Note:[/b] Real descent of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the descent of empty line). @@ -174,7 +174,7 @@ </method> <method name="get_height" qualifiers="const"> <return type="float" /> - <argument index="0" name="size" type="int" default="-1" /> + <argument index="0" name="size" type="int" default="16" /> <description> Returns the total average font height (ascent plus descent) in pixels. [b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate (e.g. as the height of empty line). @@ -184,8 +184,8 @@ <return type="Vector2" /> <argument index="0" name="text" type="String" /> <argument index="1" name="width" type="float" default="-1" /> - <argument index="2" name="size" type="int" default="-1" /> - <argument index="3" name="flags" type="int" default="48" /> + <argument index="2" name="size" type="int" default="16" /> + <argument index="3" name="flags" type="int" default="96" /> <description> Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. See also [method draw_multiline_string]. @@ -201,7 +201,7 @@ <method name="get_string_size" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="text" type="String" /> - <argument index="1" name="size" type="int" default="-1" /> + <argument index="1" name="size" type="int" default="16" /> <argument index="2" name="align" type="int" enum="HAlign" default="0" /> <argument index="3" name="width" type="float" default="-1" /> <argument index="4" name="flags" type="int" default="3" /> @@ -220,7 +220,7 @@ </method> <method name="get_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="size" type="int" default="-1" /> + <argument index="0" name="size" type="int" default="16" /> <description> Return average pixel offset of the underline below the baseline. [b]Note:[/b] Real underline position of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -228,7 +228,7 @@ </method> <method name="get_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="size" type="int" default="-1" /> + <argument index="0" name="size" type="int" default="16" /> <description> Return average thickness of the underline. [b]Note:[/b] Real underline thickness of the string is context-dependent and can be significantly different from the value returned by this function. Use it only as rough estimate. @@ -272,9 +272,6 @@ </method> </methods> <members> - <member name="base_size" type="int" setter="set_base_size" getter="get_base_size" default="16"> - Default font size. - </member> <member name="spacing_bottom" type="int" setter="set_spacing" getter="get_spacing" default="0"> Extra spacing at the bottom of the line in pixels. </member> diff --git a/doc/classes/FontData.xml b/doc/classes/FontData.xml index a814685388..c403d238c5 100644 --- a/doc/classes/FontData.xml +++ b/doc/classes/FontData.xml @@ -23,7 +23,8 @@ <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="Vector2i" /> <description> - Removes all rendered glyphs information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. + Removes all rendered glyphs information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. </description> </method> <method name="clear_kerning_map"> @@ -46,7 +47,8 @@ <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="Vector2i" /> <description> - Removes all textures from font cache entry. Note: This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually. + Removes all textures from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually. </description> </method> <method name="find_cache" qualifiers="const"> @@ -91,20 +93,45 @@ Returns font descent (number of pixels below the baseline). </description> </method> + <method name="get_fixed_size" qualifiers="const"> + <return type="int" /> + <description> + Returns font fixed size. + </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" /> <argument index="1" name="size" type="int" /> <argument index="2" name="glyph" type="int" /> <description> - Returns glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + Returns glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> <method name="get_glyph_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="char" type="int" /> - <argument index="1" name="variation_selector" type="int" /> - <argument index="2" name="arg2" type="int" /> + <argument index="0" name="size" type="int" /> + <argument index="1" name="char" type="int" /> + <argument index="2" name="variation_selector" type="int" /> <description> Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. </description> @@ -239,7 +266,7 @@ <return type="int" /> <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="int" /> - <argument index="2" name="arg2" type="int" enum="TextServer.SpacingType" /> + <argument index="2" name="spacing_type" type="int" enum="TextServer.SpacingType" /> <description> Returns extra spacing added between glyphs in pixels. </description> @@ -364,7 +391,8 @@ <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="glyph" type="int" /> <description> - Removes specified rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. + Removes specified rendered glyph information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually. </description> </method> <method name="remove_kerning"> @@ -404,7 +432,8 @@ <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="texture_index" type="int" /> <description> - Removes specified texture from font cache entry. Note: This function will not remove glyphs associated with the texture, remove them manually, using [method remove_glyph]. + Removes specified texture from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method remove_glyph]. </description> </method> <method name="render_glyph"> @@ -458,6 +487,34 @@ Sets the font descent (number of pixels below the baseline). </description> </method> + <method name="set_fixed_size"> + <return type="void" /> + <argument index="0" name="fixed_size" type="int" /> + <description> + Sets the fixed size for the font. + </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" /> @@ -472,7 +529,8 @@ <argument index="2" name="glyph" type="int" /> <argument index="3" name="advance" type="Vector2" /> <description> - Sets glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + Sets glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> <method name="set_glyph_offset"> @@ -590,8 +648,8 @@ <return type="void" /> <argument index="0" name="cache_index" type="int" /> <argument index="1" name="size" type="int" /> - <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> - <argument index="3" name="arg3" type="int" /> + <argument index="2" name="spacing_type" type="int" enum="TextServer.SpacingType" /> + <argument index="3" name="value" type="int" /> <description> Sets extra spacing added between glyphs in pixels. </description> diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index 72bd6a6411..72adc49742 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -8,7 +8,7 @@ Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles. </description> <tutorials> - <link title="Particle systems (2D)">https://docs.godotengine.org/en/latest/tutorials/2d/particle_systems_2d.html</link> + <link title="Particle systems (2D)">$DOCS_URL/tutorials/2d/particle_systems_2d.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> </tutorials> <methods> diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index 3f7b20f274..771056cb93 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -8,7 +8,7 @@ Use the [code]process_material[/code] property to add a [ParticlesMaterial] to configure particle appearance and behavior. Alternatively, you can add a [ShaderMaterial] which will be applied to all particles. </description> <tutorials> - <link title="Controlling thousands of fish with Particles">https://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/controlling_thousands_of_fish.html</link> + <link title="Controlling thousands of fish with Particles">$DOCS_URL/tutorials/performance/vertex_animation/controlling_thousands_of_fish.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 97cef205c3..b8514c67b8 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -38,8 +38,10 @@ The extra distance added to the GeometryInstance3D's bounding box ([AABB]) to increase its cull box. </member> <member name="gi_lightmap_scale" type="int" setter="set_lightmap_scale" getter="get_lightmap_scale" enum="GeometryInstance3D.LightmapScale" default="0"> + The texel density to use for lightmapping in [LightmapGI]. Greater scale values provide higher resolution in the lightmap, which can result in sharper shadows for lights that have both direct and indirect light baked. However, greater scale values will also increase the space taken by the mesh in the lightmap texture, which increases the memory, storage, and bake time requirements. When using a single mesh at different scales, consider adjusting this value to keep the lightmap texel density consistent across meshes. </member> <member name="gi_mode" type="int" setter="set_gi_mode" getter="get_gi_mode" enum="GeometryInstance3D.GIMode" default="0"> + The global illumination mode to use for the whole geometry. Use a mode that matches the purpose </member> <member name="ignore_occlusion_culling" type="bool" setter="set_ignore_occlusion_culling" getter="is_ignoring_occlusion_culling" default="false"> </member> @@ -49,6 +51,9 @@ The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. </member> + <member name="transparency" type="float" setter="set_transparency" getter="get_transparency" default="0.0"> + Transparency applied to the whole geometry. In spatial shaders, transparency is set as the default value of the [code]ALPHA[/code] built-in. + </member> <member name="visibility_range_begin" type="float" setter="set_visibility_range_begin" getter="get_visibility_range_begin" default="0.0"> Starting distance from which the GeometryInstance3D will be visible, taking [member visibility_range_begin_margin] into account as well. The default value of 0 is used to disable the range check. </member> @@ -56,15 +61,18 @@ Margin for the [member visibility_range_begin] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_begin] threshold by this amount. </member> <member name="visibility_range_end" type="float" setter="set_visibility_range_end" getter="get_visibility_range_end" default="0.0"> - Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check.. + Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check. </member> <member name="visibility_range_end_margin" type="float" setter="set_visibility_range_end_margin" getter="get_visibility_range_end_margin" default="0.0"> Margin for the [member visibility_range_end] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_end] threshold by this amount. </member> + <member name="visibility_range_fade_mode" type="int" setter="set_visibility_range_fade_mode" getter="get_visibility_range_fade_mode" enum="GeometryInstance3D.VisibilityRangeFadeMode" default="0"> + Controls which instances will be faded when approaching the limits of the visibility range. See [enum VisibilityRangeFadeMode] for possible values. + </member> </members> <constants> <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> - Will not cast any shadows. + Will not cast any shadows. Use this to improve performance for small geometry that is unlikely to cast noticeable shadows (such as debris). </constant> <constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting"> Will cast shadows from all visible faces in the GeometryInstance3D. @@ -79,20 +87,37 @@ In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be. </constant> <constant name="GI_MODE_DISABLED" value="0" enum="GIMode"> + Disabled global illumination mode. Use for dynamic objects that do not contribute to global illumination (such as characters). When using [VoxelGI] and SDFGI, the geometry will [i]receive[/i] indirect lighting and reflections but will not be considered in GI baking. When using [LightmapGI], the object will receive indirect lighting using lightmap probes instead of using the lightmap texture. </constant> <constant name="GI_MODE_BAKED" value="1" enum="GIMode"> + Baked global illumination mode. Use for static objects that contribute to global illumination (such as level geometry). This GI mode is effective when using [VoxelGI], SDFGI and [LightmapGI]. </constant> <constant name="GI_MODE_DYNAMIC" value="2" enum="GIMode"> + Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using [VoxelGI], but it has a higher performance impact than [constant GI_MODE_BAKED]. </constant> <constant name="LIGHTMAP_SCALE_1X" value="0" enum="LightmapScale"> + The standard texel density for lightmapping with [LightmapGI]. </constant> <constant name="LIGHTMAP_SCALE_2X" value="1" enum="LightmapScale"> + Multiplies texel density by 2× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor between 1.5 and 3.0. </constant> <constant name="LIGHTMAP_SCALE_4X" value="2" enum="LightmapScale"> + Multiplies texel density by 4× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor between 3.0 and 6.0. </constant> <constant name="LIGHTMAP_SCALE_8X" value="3" enum="LightmapScale"> + Multiplies texel density by 8× for lightmapping with [LightmapGI]. To ensure consistency in texel density, use this when scaling a mesh by a factor greater than 6.0. </constant> <constant name="LIGHTMAP_SCALE_MAX" value="4" enum="LightmapScale"> + Represents the size of the [enum LightmapScale] enum. + </constant> + <constant name="VISIBILITY_RANGE_FADE_DISABLED" value="0" enum="VisibilityRangeFadeMode"> + Will not fade itself nor its visibility dependencies, hysteresis will be used instead. See [member visibility_range_begin] and [member Node3D.visibility_parent] for more information. + </constant> + <constant name="VISIBILITY_RANGE_FADE_SELF" value="1" enum="VisibilityRangeFadeMode"> + Will fade-out itself when reaching the limits of its own visibility range. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. + </constant> + <constant name="VISIBILITY_RANGE_FADE_DEPENDENCIES" value="2" enum="VisibilityRangeFadeMode"> + Will fade-in its visibility dependencies (see [member Node3D.visibility_parent]) when reaching the limits of its own visibility range. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. </constant> </constants> </class> 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/GradientTexture2D.xml b/doc/classes/GradientTexture2D.xml new file mode 100644 index 0000000000..d1520861ec --- /dev/null +++ b/doc/classes/GradientTexture2D.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GradientTexture2D" inherits="Texture2D" version="4.0"> + <brief_description> + Gradient-filled 2D texture. + </brief_description> + <description> + The texture uses a [Gradient] to fill the texture data in 2D space. The gradient is filled according to the specified [member fill] and [member repeat] types using colors obtained from the gradient. 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] and [member height]). + </description> + <tutorials> + </tutorials> + <members> + <member name="fill" type="int" setter="set_fill" getter="get_fill" enum="GradientTexture2D.Fill" default="0"> + The gradient fill type, one of the [enum Fill] values. The texture is filled by interpolating colors starting from [member fill_from] to [member fill_to] offsets. + </member> + <member name="fill_from" type="Vector2" setter="set_fill_from" getter="get_fill_from" default="Vector2(0, 0)"> + The initial offset used to fill the texture specified in UV coordinates. + </member> + <member name="fill_to" type="Vector2" setter="set_fill_to" getter="get_fill_to" default="Vector2(1, 0)"> + The final offset used to fill the texture specified in UV coordinates. + </member> + <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> + The [Gradient] used to fill the texture. + </member> + <member name="height" type="int" setter="set_height" getter="get_height" default="64"> + The number of vertical color samples that will be obtained from the [Gradient], which also represents the texture's height. + </member> + <member name="repeat" type="int" setter="set_repeat" getter="get_repeat" enum="GradientTexture2D.Repeat" default="0"> + The gradient repeat type, one of the [enum Repeat] values. The texture is filled starting from [member fill_from] to [member fill_to] offsets by default, but the gradient fill can be repeated to cover the entire texture. + </member> + <member name="use_hdr" type="bool" setter="set_use_hdr" getter="is_using_hdr" default="false"> + If [code]true[/code], the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is [code]true[/code]. If [code]false[/code], the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). + </member> + <member name="width" type="int" setter="set_width" getter="get_width" default="64"> + The number of horizontal color samples that will be obtained from the [Gradient], which also represents the texture's width. + </member> + </members> + <constants> + <constant name="FILL_LINEAR" value="0" enum="Fill"> + The colors are linearly interpolated in a straight line. + </constant> + <constant name="FILL_RADIAL" value="1" enum="Fill"> + The colors are linearly interpolated in a circular pattern. + </constant> + <constant name="REPEAT_NONE" value="0" enum="Repeat"> + The gradient fill is restricted to the range defined by [member fill_from] to [member fill_to] offsets. + </constant> + <constant name="REPEAT" value="1" enum="Repeat"> + The texture is filled starting from [member fill_from] to [member fill_to] offsets, repeating the same pattern in both directions. + </constant> + <constant name="REPEAT_MIRROR" value="2" enum="Repeat"> + The texture is filled starting from [member fill_from] to [member fill_to] offsets, mirroring the pattern in both directions. + </constant> + </constants> +</class> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 2213b9b8b2..e962992491 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -89,8 +89,8 @@ <method name="get_zoom_hbox"> <return type="HBoxContainer" /> <description> - Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. - Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of its children, use their [member CanvasItem.visible] property instead. + Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="is_node_connected"> @@ -141,7 +141,7 @@ <argument index="3" name="to_port" type="int" /> <argument index="4" name="amount" type="float" /> <description> - Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property. + Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [theme_item activity] theme property. </description> </method> <method name="set_selected"> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index ff6271d2aa..e9226f7c1d 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -285,10 +285,10 @@ No overlay is shown. </constant> <constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay"> - Show overlay set in the [code]breakpoint[/code] theme property. + Show overlay set in the [theme_item breakpoint] theme property. </constant> <constant name="OVERLAY_POSITION" value="2" enum="Overlay"> - Show overlay set in the [code]position[/code] theme property. + Show overlay set in the [theme_item position] theme property. </constant> </constants> <theme_items> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 9f33c400f4..a50983853d 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -15,8 +15,8 @@ [b]Warning:[/b] SSL/TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. </description> <tutorials> - <link title="HTTP client class">https://docs.godotengine.org/en/latest/tutorials/networking/http_client_class.html</link> - <link title="SSL certificates">https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link> + <link title="HTTP client class">$DOCS_URL/tutorials/networking/http_client_class.html</link> + <link title="SSL certificates">$DOCS_URL/tutorials/networking/ssl_certificates.html</link> </tutorials> <methods> <method name="close"> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 558e51aefe..aaaf863c69 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -153,8 +153,8 @@ [b]Gzipped response bodies[/b]: HTTPRequest will automatically handle decompression of response bodies. A [code]Accept-Encoding[/code] header will be automatically added to each of your requests, unless one is already specified. Any response with a [code]Content-Encoding: gzip[/code] header will automatically be decompressed and delivered to you as uncompressed bytes. </description> <tutorials> - <link title="Making HTTP requests">https://docs.godotengine.org/en/latest/tutorials/networking/http_request_class.html</link> - <link title="SSL certificates">https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link> + <link title="Making HTTP requests">$DOCS_URL/tutorials/networking/http_request_class.html</link> + <link title="SSL certificates">$DOCS_URL/tutorials/networking/ssl_certificates.html</link> </tutorials> <methods> <method name="cancel_request"> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 5d79e22c49..8a4bbee0fa 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -9,7 +9,7 @@ [b]Note:[/b] The maximum image size is 16384×16384 pixels due to graphics hardware limitations. Larger images may fail to import. </description> <tutorials> - <link title="Importing images">https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html</link> + <link title="Importing images">$DOCS_URL/tutorials/assets_pipeline/importing_images.html</link> </tutorials> <methods> <method name="adjust_bcs"> @@ -154,7 +154,15 @@ <return type="void" /> <argument index="0" name="color" type="Color" /> <description> - Fills the image with a given [Color]. + Fills the image with [code]color[/code]. + </description> + </method> + <method name="fill_rect"> + <return type="void" /> + <argument index="0" name="rect" type="Rect2" /> + <argument index="1" name="color" type="Color" /> + <description> + Fills [code]rect[/code] with [code]color[/code]. </description> </method> <method name="fix_alpha_edges"> @@ -278,7 +286,7 @@ <return type="int" enum="Error" /> <argument index="0" name="path" type="String" /> <description> - Loads an image from file [code]path[/code]. See [url=https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. + Loads an image from file [code]path[/code]. See [url=$DOCS_URL/getting_started/workflow/assets/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the [code]user://[/code] directory, and may not work in exported projects. See also [ImageTexture] description for usage examples. </description> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index af7178db95..3f96d357b6 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -28,7 +28,7 @@ [b]Note:[/b] The maximum texture size is 16384×16384 pixels due to graphics hardware limitations. </description> <tutorials> - <link title="Importing images">https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html</link> + <link title="Importing images">$DOCS_URL/tutorials/assets_pipeline/importing_images.html</link> </tutorials> <methods> <method name="create_from_image"> diff --git a/doc/classes/EditorSceneImporterMesh.xml b/doc/classes/ImporterMesh.xml index 5d57a76d5f..ab344f908c 100644 --- a/doc/classes/EditorSceneImporterMesh.xml +++ b/doc/classes/ImporterMesh.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporterMesh" inherits="Resource" version="4.0"> +<class name="ImporterMesh" inherits="Resource" version="4.0"> <brief_description> A [Resource] that contains vertex array-based geometry during the import process. </brief_description> <description> - EditorSceneImporterMesh is a type of [Resource] analogous to [ArrayMesh]. It contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. + ImporterMesh is a type of [Resource] analogous to [ArrayMesh]. It contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. - Unlike its runtime counterpart, [EditorSceneImporterMesh] contains mesh data before various import steps, such as lod and shadow mesh generation, have taken place. Modify surface data by calling [method clear], followed by [method add_surface] for each surface. + Unlike its runtime counterpart, [ImporterMesh] contains mesh data before various import steps, such as lod and shadow mesh generation, have taken place. Modify surface data by calling [method clear], followed by [method add_surface] for each surface. </description> <tutorials> </tutorials> @@ -37,7 +37,7 @@ <method name="clear"> <return type="void" /> <description> - Removes all surfaces and blend shapes from this [EditorSceneImporterMesh]. + Removes all surfaces and blend shapes from this [ImporterMesh]. </description> </method> <method name="get_blend_shape_count" qualifiers="const"> @@ -69,7 +69,7 @@ <return type="ArrayMesh" /> <argument index="0" name="base_mesh" type="ArrayMesh" default="null" /> <description> - Returns the mesh data represented by this [EditorSceneImporterMesh] as a usable [ArrayMesh]. + Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh]. This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called. If not yet cached and [code]base_mesh[/code] is provided, [code]base_mesh[/code] will be used and mutated. </description> diff --git a/doc/classes/EditorSceneImporterMeshNode3D.xml b/doc/classes/ImporterMeshInstance3D.xml index 848448110e..6d572f543b 100644 --- a/doc/classes/EditorSceneImporterMeshNode3D.xml +++ b/doc/classes/ImporterMeshInstance3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporterMeshNode3D" inherits="Node3D" version="4.0"> +<class name="ImporterMeshInstance3D" inherits="Node3D" version="4.0"> <brief_description> </brief_description> <description> @@ -7,7 +7,7 @@ <tutorials> </tutorials> <members> - <member name="mesh" type="EditorSceneImporterMesh" setter="set_mesh" getter="get_mesh"> + <member name="mesh" type="ImporterMesh" setter="set_mesh" getter="get_mesh"> </member> <member name="skeleton_path" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath("")"> </member> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index ebbcd2b894..cd5ba2e17f 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -7,7 +7,7 @@ A singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b], or with the [InputMap] class. </description> <tutorials> - <link title="Inputs tutorial index">https://docs.godotengine.org/en/latest/tutorials/inputs/index.html</link> + <link title="Inputs documentation index">$DOCS_URL/tutorials/inputs/index.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> @@ -37,6 +37,13 @@ Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. </description> </method> + <method name="flush_buffered_events"> + <return type="void" /> + <description> + Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input ([method set_use_accumulated_input]) or agile input flushing ([member ProjectSettings.input_devices/buffering/agile_event_flushing]). + The engine will already do this itself at key execution points (at least once per frame). However, this can be useful in advanced cases where you want precise control over the timing of event handling. + </description> + </method> <method name="get_accelerometer" qualifiers="const"> <return type="Vector3" /> <description> @@ -148,7 +155,7 @@ </description> </method> <method name="get_mouse_button_mask" qualifiers="const"> - <return type="int" /> + <return type="int" enum="MouseButton" /> <description> Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. </description> @@ -229,6 +236,13 @@ Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton]. </description> </method> + <method name="is_physical_key_pressed" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="keycode" type="int" enum="Key" /> + <description> + Returns [code]true[/code] if you are pressing the key in the physical location on the 101/102-key US QWERTY keyboard. You can pass a [enum Key] constant. + </description> + </method> <method name="joy_connection_changed"> <return type="void" /> <argument index="0" name="device" type="int" /> @@ -269,6 +283,14 @@ Removes all mappings from the internal database that match the given GUID. </description> </method> + <method name="set_accelerometer"> + <return type="void" /> + <argument index="0" name="value" type="Vector3" /> + <description> + Sets the acceleration value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. + [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. + </description> + </method> <method name="set_custom_mouse_cursor"> <return type="void" /> <argument index="0" name="image" type="Resource" /> @@ -291,6 +313,30 @@ [b]Note:[/b] This method generates an [InputEventMouseMotion] to update cursor immediately. </description> </method> + <method name="set_gravity"> + <return type="void" /> + <argument index="0" name="value" type="Vector3" /> + <description> + Sets the gravity value of the accelerometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. + [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. + </description> + </method> + <method name="set_gyroscope"> + <return type="void" /> + <argument index="0" name="value" type="Vector3" /> + <description> + Sets the value of the rotation rate of the gyroscope sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. + [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. + </description> + </method> + <method name="set_magnetometer"> + <return type="void" /> + <argument index="0" name="value" type="Vector3" /> + <description> + Sets the value of the magnetic field of the magnetometer sensor. Can be used for debugging on devices without a hardware sensor, for example in an editor on a PC. + [b]Note:[/b] This value can be immediately overwritten by the hardware sensor value on Android and iOS. + </description> + </method> <method name="set_mouse_mode"> <return type="void" /> <argument index="0" name="mode" type="int" enum="Input.MouseMode" /> @@ -386,6 +432,7 @@ </constant> <constant name="CURSOR_DRAG" value="6" enum="CursorShape"> Drag cursor. Usually displayed when dragging something. + [b]Note:[/b] Windows lacks a dragging cursor, so [constant CURSOR_DRAG] is the same as [constant CURSOR_MOVE] for this platform. </constant> <constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape"> Can drop cursor. Usually displayed when dragging something to indicate that it can be dropped at the current position. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 9dc8fbeffa..09fbe776bf 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -7,8 +7,8 @@ Base class of all sort of input event. See [method Node._input]. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index f09af1a34d..e9c280732a 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -7,7 +7,7 @@ Contains a generic action which can be targeted from several types of inputs. Actions can be created from the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b] menu. See [method Node._input]. </description> <tutorials> - <link title="InputEvent: Actions">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#actions</link> + <link title="InputEvent: Actions">$DOCS_URL/tutorials/inputs/inputevent.html#actions</link> <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index ff82913385..3e625c1003 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -7,7 +7,7 @@ Input event type for gamepad buttons. For gamepad analog sticks and joysticks, see [InputEventJoypadMotion]. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="JoyButton" default="0"> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 92161974ba..b3f9013553 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -7,7 +7,7 @@ Stores information about joystick motions. One [InputEventJoypadMotion] represents one axis at a time. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> <member name="axis" type="int" setter="set_axis" getter="get_axis" enum="JoyAxis" default="0"> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 9cf6872655..8044bf5b99 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -7,18 +7,18 @@ Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <methods> <method name="get_keycode_with_modifiers" qualifiers="const"> - <return type="int" /> + <return type="int" enum="Key" /> <description> Returns the keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. </description> </method> <method name="get_physical_keycode_with_modifiers" qualifiers="const"> - <return type="int" /> + <return type="int" enum="Key" /> <description> Returns the physical keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_keycode_string(event.get_physical_keycode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index b06068aff3..4878090996 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -7,10 +7,10 @@ Stores general mouse events information. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> - <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" default="0"> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask" enum="MouseButton" default="0"> The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks. </member> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" default="Vector2(0, 0)"> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index dcfe0d6c71..699217525e 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -7,7 +7,7 @@ Contains mouse click information. See [method Node._input]. </description> <tutorials> - <link title="Mouse and input coordinates">https://docs.godotengine.org/en/latest/tutorials/inputs/mouse_and_input_coordinates.html</link> + <link title="Mouse and input coordinates">$DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link> </tutorials> <members> <member name="button_index" type="int" setter="set_button_index" getter="get_button_index" enum="MouseButton" default="0"> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 9a0156510e..bd1ae367c2 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -8,7 +8,7 @@ [b]Note:[/b] By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, call [method Input.set_use_accumulated_input] with [code]false[/code] to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing [url=https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm]Bresenham's line algorithm[/url] as well to avoid visible gaps in lines if the user is moving the mouse quickly. </description> <tutorials> - <link title="Mouse and input coordinates">https://docs.godotengine.org/en/latest/tutorials/inputs/mouse_and_input_coordinates.html</link> + <link title="Mouse and input coordinates">$DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <members> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 373936225b..19c26e3a98 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -7,7 +7,7 @@ Contains screen drag information. See [method Node._input]. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> <member name="index" type="int" setter="set_index" getter="get_index" default="0"> @@ -17,7 +17,7 @@ The drag position. </member> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative" default="Vector2(0, 0)"> - The drag position relative to its start position. + The drag position relative to the previous position (position at the last frame). </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed" default="Vector2(0, 0)"> The drag speed. diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index c731044c98..0694b2eabc 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -8,7 +8,7 @@ Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> <member name="index" type="int" setter="set_index" getter="get_index" default="0"> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 1b9212bf65..cd4a8aecd0 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -7,7 +7,7 @@ Contains keys events information with modifiers support like [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See [method Node._input]. </description> <tutorials> - <link title="InputEvent">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link> + <link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link> </tutorials> <members> <member name="alt_pressed" type="bool" setter="set_alt_pressed" getter="is_alt_pressed" default="false"> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index 855d5b5d71..24f220e892 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -7,7 +7,7 @@ Manages all [InputEventAction] which can be created/modified from the project settings menu [b]Project > Project Settings > Input Map[/b] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. </description> <tutorials> - <link title="InputEvent: InputMap">https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html#inputmap</link> + <link title="InputEvent: InputMap">$DOCS_URL/tutorials/inputs/inputevent.html#inputmap</link> </tutorials> <methods> <method name="action_add_event"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index e3e4a9fa7d..baa0faaae9 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -71,12 +71,6 @@ When there is no item at that point, -1 will be returned if [code]exact[/code] is [code]true[/code], and the closest item index will be returned otherwise. </description> </method> - <method name="get_item_count" qualifiers="const"> - <return type="int" /> - <description> - Returns the number of items currently in the list. - </description> - </method> <method name="get_item_custom_bg_color" qualifiers="const"> <return type="Color" /> <argument index="0" name="idx" type="int" /> @@ -165,6 +159,7 @@ <return type="VScrollBar" /> <description> Returns the [Object] ID associated with the list. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="is_anything_selected"> @@ -386,6 +381,9 @@ <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale" default="1.0"> The scale of icon applied after [member fixed_icon_size] and transposing takes effect. </member> + <member name="items_count" type="int" setter="set_item_count" getter="get_item_count" default="0"> + The number of items currently in the list. + </member> <member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns" default="1"> Maximum columns the list will have. If greater than zero, the content will be split among the specified columns. diff --git a/doc/classes/JNISingleton.xml b/doc/classes/JNISingleton.xml index ce39e1f567..c887f72767 100644 --- a/doc/classes/JNISingleton.xml +++ b/doc/classes/JNISingleton.xml @@ -7,6 +7,6 @@ The JNISingleton is implemented only in the Android export. It's used to call methods and connect signals from an Android plugin written in Java or Kotlin. Methods and signals can be called and connected to the JNISingleton as if it is a Node. See [url=https://en.wikipedia.org/wiki/Java_Native_Interface]Java Native Interface - Wikipedia[/url] for more information. </description> <tutorials> - <link title="Creating Android plugins">https://docs.godotengine.org/en/latest/tutorials/platform/android/android_plugin.html#doc-android-plugin</link> + <link title="Creating Android plugins">$DOCS_URL/tutorials/platform/android/android_plugin.html#doc-android-plugin</link> </tutorials> </class> diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index 5865ad734e..aeaf8ac1f5 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -5,10 +5,10 @@ </brief_description> <description> The JavaScript singleton is implemented only in the HTML5 export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. - [b]Note:[/b] This singleton can be disabled at build-time to improve security. By default, the JavaScript singleton is enabled. Official export templates also have the JavaScript singleton enabled. See [url=https://docs.godotengine.org/en/latest/development/compiling/compiling_for_web.html]Compiling for the Web[/url] in the documentation for more information. + [b]Note:[/b] This singleton can be disabled at build-time to improve security. By default, the JavaScript singleton is enabled. Official export templates also have the JavaScript singleton enabled. See [url=$DOCS_URL/development/compiling/compiling_for_web.html]Compiling for the Web[/url] in the documentation for more information. </description> <tutorials> - <link title="Exporting for the Web: Calling JavaScript from script">https://docs.godotengine.org/en/latest/getting_started/workflow/export/exporting_for_web.html#calling-javascript-from-script</link> + <link title="Exporting for the Web: Calling JavaScript from script">$DOCS_URL/tutorials/export/exporting_for_web.html#calling-javascript-from-script</link> </tutorials> <methods> <method name="create_callback"> diff --git a/doc/classes/JavaScriptObject.xml b/doc/classes/JavaScriptObject.xml index 5aa54a7d0c..6dd8702d5f 100644 --- a/doc/classes/JavaScriptObject.xml +++ b/doc/classes/JavaScriptObject.xml @@ -31,7 +31,7 @@ # [0, 9, [JavaScriptObject:1180]] print(args) [/codeblock] - Note: Only available in the "HTML5" platform. + [b]Note:[/b] Only available in the HTML5 platform. </description> <tutorials> </tutorials> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 29fc4700fd..23b01a0fc9 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -14,43 +14,74 @@ <return type="float" /> <argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> <description> - The collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's attached [Object]. + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the unique instance ID of the colliding body's attached [Object]. See [method Object.get_instance_id]. + </description> + </method> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID" /> + <description> + Returns the colliding body's [RID] used by the [PhysicsServer2D]. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's shape. + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int" /> + <description> + Returns the colliding body's shape index. See [CollisionObject2D]. + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's velocity. + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the moving object's colliding shape. + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's shape's normal at the point of collision. + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the point of collision in global coordinates. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_collider"> - The colliding body. - </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> - The colliding body's unique instance ID. See [method Object.get_instance_id]. - </member> - <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> - The colliding body's [RID] used by the [PhysicsServer2D]. - </member> - <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> - The colliding body's shape. - </member> - <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0"> - The colliding shape's index. See [CollisionObject2D]. - </member> - <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)"> - The colliding object's velocity. - </member> - <member name="local_shape" type="Object" setter="" getter="get_local_shape"> - The moving object's colliding shape. - </member> - <member name="normal" type="Vector2" setter="" getter="get_normal" default="Vector2(0, 0)"> - The colliding body's shape's normal at the point of collision. - </member> - <member name="position" type="Vector2" setter="" getter="get_position" default="Vector2(0, 0)"> - The point of collision, in global coordinates. - </member> - <member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)"> - The moving object's remaining movement vector. - </member> - <member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)"> - The distance the moving object traveled before collision. - </member> - </members> </class> diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 3db6fe019b..372113b281 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -15,108 +15,89 @@ <argument index="0" name="collision_index" type="int" default="0" /> <argument index="1" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> <description> - The collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. </description> </method> <method name="get_collider" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider by index (the latest by default). + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider ID by index (the latest by default). + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider RID by index (the latest by default). + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider shape by index (the latest by default). + Returns the colliding body's shape given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape_index" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider shape index by index (the latest by default). + Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider velocity by index (the latest by default). + Returns the colliding body's velocity given a collision index (the deepest collision by default). + </description> + </method> + <method name="get_collision_count" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of detected collisions. </description> </method> <method name="get_local_shape" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider velocity by index (the latest by default). + Returns the moving object's colliding shape given a collision index (the deepest collision by default). </description> </method> <method name="get_normal" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider normal by index (the latest by default). + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). </description> </method> <method name="get_position" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider collision point by index (the latest by default). + Returns the point of collision in global coordinates given a collision index (the deepest collision by default). + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_best_collider"> - The colliding body. - </member> - <member name="collider_id" type="int" setter="" getter="get_best_collider_id" default="0"> - The colliding body's unique instance ID. See [method Object.get_instance_id]. - </member> - <member name="collider_rid" type="RID" setter="" getter="get_best_collider_rid"> - The colliding body's [RID] used by the [PhysicsServer3D]. - </member> - <member name="collider_shape" type="Object" setter="" getter="get_best_collider_shape"> - The colliding body's shape. - </member> - <member name="collider_shape_index" type="int" setter="" getter="get_best_collider_shape_index" default="0"> - The colliding shape's index. See [CollisionObject3D]. - </member> - <member name="collider_velocity" type="Vector3" setter="" getter="get_best_collider_velocity" default="Vector3(0, 0, 0)"> - The colliding object's velocity. - </member> - <member name="collision_count" type="int" setter="" getter="get_collision_count" default="0"> - </member> - <member name="local_shape" type="Object" setter="" getter="get_best_local_shape"> - The moving object's colliding shape. - </member> - <member name="normal" type="Vector3" setter="" getter="get_best_normal" default="Vector3(0, 0, 0)"> - The colliding body's shape's normal at the point of collision. - </member> - <member name="position" type="Vector3" setter="" getter="get_best_position" default="Vector3(0, 0, 0)"> - The point of collision, in global coordinates. - </member> - <member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3(0, 0, 0)"> - The moving object's remaining movement vector. - </member> - <member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3(0, 0, 0)"> - The distance the moving object traveled before collision. - </member> - </members> </class> 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/Light2D.xml b/doc/classes/Light2D.xml index 918e8a5c8a..039425b15f 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -8,7 +8,7 @@ [b]Note:[/b] Light2D can also be used as a mask. </description> <tutorials> - <link title="2D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/2d/2d_lights_and_shadows.html</link> + <link title="2D lights and shadows">$DOCS_URL/tutorials/2d/2d_lights_and_shadows.html</link> </tutorials> <methods> <method name="get_height" qualifiers="const"> diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index 52359b0ede..009ad1f609 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -7,7 +7,7 @@ Light3D is the [i]abstract[/i] base class for light nodes. As it can't be instantiated, it shouldn't be used directly. Other types of light nodes inherit from it. Light3D contains the common variables and parameters used for lighting. </description> <tutorials> - <link title="3D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> + <link title="3D lights and shadows">$DOCS_URL/tutorials/3d/lights_and_shadows.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> @@ -32,7 +32,7 @@ If [code]true[/code], the light only appears in the editor and will not be visible at runtime. </member> <member name="light_angular_distance" type="float" setter="set_param" getter="get_param" default="0.0"> - The light's angular size in degrees. Only available for [DirectionalLight3D]s. For reference, the Sun from the Earth is approximately [code]0.5[/code]. + The light's angular size in degrees. Increasing this will make shadows softer at greater distances. Only available for [DirectionalLight3D]s. For reference, the Sun from the Earth is approximately [code]0.5[/code]. </member> <member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light3D.BakeMode" default="1"> The light's bake mode. See [enum BakeMode]. diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml index ba795a29a1..d883128ac3 100644 --- a/doc/classes/LightOccluder2D.xml +++ b/doc/classes/LightOccluder2D.xml @@ -7,7 +7,7 @@ Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an [OccluderPolygon2D] in order for the shadow to be computed. </description> <tutorials> - <link title="2D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/2d/2d_lights_and_shadows.html</link> + <link title="2D lights and shadows">$DOCS_URL/tutorials/2d/2d_lights_and_shadows.html</link> </tutorials> <members> <member name="occluder" type="OccluderPolygon2D" setter="set_occluder_polygon" getter="get_occluder_polygon"> diff --git a/doc/classes/LightmapGI.xml b/doc/classes/LightmapGI.xml index 0cdf9f820f..b7d4c93fd5 100644 --- a/doc/classes/LightmapGI.xml +++ b/doc/classes/LightmapGI.xml @@ -1,8 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="LightmapGI" inherits="VisualInstance3D" version="4.0"> <brief_description> + Computes and stores baked lightmaps for fast global illumination. </brief_description> <description> + The [LightmapGI] node is used to compute and store baked lightmaps. Lightmaps are used to provide high-quality indirect lighting with very little light leaking. [LightmapGI] can also provide rough reflections using spherical harmonics if [member directional] is enabled. Dynamic objects can receive indirect lighting thanks to [i]light probes[/i], which can be automatically placed by setting [member generate_probes_subdiv]. Additional lightmap probes can also be added by creating [LightmapProbe] nodes. The downside is that lightmaps are fully static and cannot be baked in an exported project. Baking a [LightmapGI] node is also slower compared to [VoxelGI]. + [b]Procedural generation:[/b] Lightmap baking functionality is only available in the editor. This means [LightmapGI] is not suited to procedurally generated or user-built levels. For procedurally generated or user-built levels, use [VoxelGI] or SDFGI instead (see [member Environment.sdfgi_enabled]). + [b]Performance:[/b] [LightmapGI] provides the best possible run-time performance for global illumination. It is suitable for low-end hardware including integrated graphics and mobile devices. </description> <tutorials> </tutorials> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 4d9abbbb19..5e673cc19b 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -82,7 +82,7 @@ The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. </member> <member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit" default="2.0"> - The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [constant LINE_JOINT_SHARP]. + The direction difference in radians between vector points. This value is only used if [member joint_mode] is set to [constant LINE_JOINT_SHARP]. </member> <member name="texture" type="Texture2D" setter="set_texture" getter="get_texture"> The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 83e3f5b05a..a75bd2f704 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -67,6 +67,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_opentype_feature" qualifiers="const"> @@ -175,7 +176,7 @@ </member> <member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false"> Allow moving caret, selecting and removing the individual composite character components. - Note: [kbd]Backspace[/kbd] is always removing individual composite character components. + [b]Note:[/b] [kbd]Backspace[/kbd] is always removing individual composite character components. </member> <member name="clear_button_enabled" type="bool" setter="set_clear_button_enabled" getter="is_clear_button_enabled" default="false"> If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty, which can be used to clear the text quickly. @@ -183,6 +184,9 @@ <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="true"> If [code]true[/code], the context menu will appear when right-clicked. </member> + <member name="deselect_on_focus_loss_enabled" type="bool" setter="set_deselect_on_focus_loss_enabled" getter="is_deselect_on_focus_loss_enabled" default="true"> + If [code]true[/code], the selected text will be deselected when focus is lost. + </member> <member name="draw_control_chars" type="bool" setter="set_draw_control_chars" getter="get_draw_control_chars" default="false"> If [code]true[/code], control characters are displayed. </member> @@ -192,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. @@ -221,6 +228,10 @@ [/csharp] [/codeblocks] </member> + <member name="middle_mouse_paste_enabled" type="bool" setter="set_middle_mouse_paste_enabled" getter="is_middle_mouse_paste_enabled" default="true"> + If [code]false[/code], using middle mouse button to paste clipboard will be disabled. + [b]Note:[/b] This method is only implemented on Linux. + </member> <member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" override="true" enum="Control.CursorShape" default="1" /> <member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha" default="0.6"> Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code]. diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index e4445e9076..0329ed833f 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -75,6 +75,9 @@ <theme_item name="font_color" data_type="color" type="Color" default="Color(0.88, 0.88, 0.88, 1)"> Default text [Color] of the [LinkButton]. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + Text [Color] used when the [LinkButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> Text [Color] used when the [LinkButton] is being hovered. </theme_item> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index a3e98228c6..f77b69b1f9 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -20,11 +20,12 @@ <members> <member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass"> Sets the [Material] to be used for the next pass. This renders the object again using a different material. - [b]Note:[/b] only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". + [b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". </member> <member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0"> Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. - [b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). + [b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". + [b]Note:[/b] This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). </member> </members> <constants> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 5bdc9cccd9..7f9d3d96dc 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -15,6 +15,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="set_disable_shortcuts"> @@ -29,6 +30,9 @@ <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" override="true" enum="BaseButton.ActionMode" default="0" /> <member name="flat" type="bool" setter="set_flat" getter="is_flat" override="true" default="true" /> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="0" /> + <member name="items_count" type="int" setter="set_item_count" getter="get_item_count" default="0"> + The number of items currently in the list. + </member> <member name="switch_on_hover" type="bool" setter="set_switch_on_hover" getter="is_switch_on_hover" default="false"> If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one. </member> @@ -57,6 +61,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.3)"> Text [Color] used when the [MenuButton] is disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + Text [Color] used when the [MenuButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> Text [Color] used when the [MenuButton] is being hovered. </theme_item> diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml index c7b66c8ea3..6873edb3ae 100644 --- a/doc/classes/MeshInstance2D.xml +++ b/doc/classes/MeshInstance2D.xml @@ -7,7 +7,7 @@ Node used for displaying a [Mesh] in 2D. Can be constructed from an existing [Sprite2D] via a tool in the editor toolbar. Select "Sprite2D" then "Convert to Mesh2D", select settings in popup and press "Create Mesh2D". </description> <tutorials> - <link title="2D meshes">https://docs.godotengine.org/en/latest/tutorials/2d/2d_meshes.html</link> + <link title="2D meshes">$DOCS_URL/tutorials/2d/2d_meshes.html</link> </tutorials> <members> <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml index 507a76197a..b72ce46310 100644 --- a/doc/classes/MeshInstance3D.xml +++ b/doc/classes/MeshInstance3D.xml @@ -41,6 +41,12 @@ This helper creates a [StaticBody3D] child node with a [ConcavePolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> + <method name="find_blend_shape_by_name"> + <return type="int" /> + <argument index="0" name="name" type="StringName" /> + <description> + </description> + </method> <method name="get_active_material" qualifiers="const"> <return type="Material" /> <argument index="0" name="surface" type="int" /> @@ -48,6 +54,17 @@ Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material. </description> </method> + <method name="get_blend_shape_count" qualifiers="const"> + <return type="int" /> + <description> + </description> + </method> + <method name="get_blend_shape_value" qualifiers="const"> + <return type="float" /> + <argument index="0" name="blend_shape_idx" type="int" /> + <description> + </description> + </method> <method name="get_surface_override_material" qualifiers="const"> <return type="Material" /> <argument index="0" name="surface" type="int" /> @@ -61,6 +78,13 @@ Returns the number of surface override materials. This is equivalent to [method Mesh.get_surface_count]. </description> </method> + <method name="set_blend_shape_value"> + <return type="void" /> + <argument index="0" name="blend_shape_idx" type="int" /> + <argument index="1" name="value" type="float" /> + <description> + </description> + </method> <method name="set_surface_override_material"> <return type="void" /> <argument index="0" name="surface" type="int" /> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 7b4a53a810..cf3b395b7b 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -10,8 +10,8 @@ Since instances may have any behavior, the AABB used for visibility must be provided by the user. </description> <tutorials> - <link title="Animating thousands of fish with MultiMeshInstance">https://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/animating_thousands_of_fish.html</link> - <link title="Optimization using MultiMeshes">https://docs.godotengine.org/en/latest/tutorials/optimization/using_multimesh.html</link> + <link title="Animating thousands of fish with MultiMeshInstance">$DOCS_URL/tutorials/performance/vertex_animation/animating_thousands_of_fish.html</link> + <link title="Optimization using MultiMeshes">$DOCS_URL/tutorials/performance/using_multimesh.html</link> </tutorials> <methods> <method name="get_aabb" qualifiers="const"> diff --git a/doc/classes/MultiMeshInstance3D.xml b/doc/classes/MultiMeshInstance3D.xml index 7bf05d2d34..d78a045aca 100644 --- a/doc/classes/MultiMeshInstance3D.xml +++ b/doc/classes/MultiMeshInstance3D.xml @@ -8,9 +8,9 @@ This is useful to optimize the rendering of a high amount of instances of a given mesh (for example trees in a forest or grass strands). </description> <tutorials> - <link title="Animating thousands of fish with MultiMeshInstance">https://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/animating_thousands_of_fish.html</link> - <link title="Using MultiMeshInstance">https://docs.godotengine.org/en/latest/tutorials/3d/using_multi_mesh_instance.html</link> - <link title="Optimization using MultiMeshes">https://docs.godotengine.org/en/latest/tutorials/optimization/using_multimesh.html</link> + <link title="Animating thousands of fish with MultiMeshInstance">$DOCS_URL/tutorials/performance/vertex_animation/animating_thousands_of_fish.html</link> + <link title="Using MultiMeshInstance">$DOCS_URL/tutorials/3d/using_multi_mesh_instance.html</link> + <link title="Optimization using MultiMeshes">$DOCS_URL/tutorials/performance/using_multimesh.html</link> </tutorials> <members> <member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh"> diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 15517f7c2f..b7bd7bef36 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -9,7 +9,7 @@ [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. </description> <tutorials> - <link title="High-level multiplayer">https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html</link> + <link title="High-level multiplayer">$DOCS_URL/tutorials/networking/high_level_multiplayer.html</link> <link title="WebRTC Signaling Demo">https://godotengine.org/asset-library/asset/537</link> </tutorials> <methods> @@ -58,7 +58,7 @@ </member> <member name="transfer_channel" type="int" setter="set_transfer_channel" getter="get_transfer_channel" default="0"> The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send [b]different and independent[/b] state updates is a common way to optimize network usage and decrease latency in fast-paced games. - [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. + [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_UNRELIABLE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. </member> <member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="TransferMode" default="2"> The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. diff --git a/doc/classes/MultiplayerReplicator.xml b/doc/classes/MultiplayerReplicator.xml index e0c309ef39..0f97cc1d0a 100644 --- a/doc/classes/MultiplayerReplicator.xml +++ b/doc/classes/MultiplayerReplicator.xml @@ -95,7 +95,7 @@ <argument index="1" name="peer_id" type="int" default="0" /> <description> Manually request a sync for all the instances of the scene identified by [code]scene_id[/code]. This function will trigger the default sync behaviour, or call your send custom send callable if specified in [method sync_config]. - Note: The default implementation only allow syncing from server to clients. + [b]Note:[/b] The default implementation only allow syncing from server to clients. </description> </method> <method name="sync_config"> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index eb9bec1104..90c81686b1 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -7,7 +7,7 @@ A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks. </description> <tutorials> - <link title="Using multiple threads">https://docs.godotengine.org/en/latest/tutorials/threads/using_multiple_threads.html</link> + <link title="Using multiple threads">$DOCS_URL/tutorials/performance/using_multiple_threads.html</link> </tutorials> <methods> <method name="lock"> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index e476949360..b100a20963 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -84,7 +84,7 @@ <member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope" default="45.0"> The maximum slope that is considered walkable, in degrees. </member> - <member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.6"> + <member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="1.0"> The distance to erode/shrink the walkable area of the heightfield away from obstructions. [b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell/size]. </member> diff --git a/doc/classes/NavigationObstacle2D.xml b/doc/classes/NavigationObstacle2D.xml index 462532d49a..b73d7f2bec 100644 --- a/doc/classes/NavigationObstacle2D.xml +++ b/doc/classes/NavigationObstacle2D.xml @@ -8,4 +8,12 @@ </description> <tutorials> </tutorials> + <members> + <member name="estimate_radius" type="bool" setter="set_estimate_radius" getter="is_radius_estimated" default="true"> + Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + The radius of the agent. Used only if [member estimate_radius] is set to false. + </member> + </members> </class> diff --git a/doc/classes/NavigationObstacle3D.xml b/doc/classes/NavigationObstacle3D.xml index c0cb7befef..c126c0430f 100644 --- a/doc/classes/NavigationObstacle3D.xml +++ b/doc/classes/NavigationObstacle3D.xml @@ -8,4 +8,12 @@ </description> <tutorials> </tutorials> + <members> + <member name="estimate_radius" type="bool" setter="set_estimate_radius" getter="is_radius_estimated" default="true"> + Enables radius estimation algorithm which uses parent's collision shapes to determine the obstacle radius. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + The radius of the agent. Used only if [member estimate_radius] is set to false. + </member> + </members> </class> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index 5b5b7c42ef..7ecdca8793 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -28,7 +28,7 @@ var polygon = NavigationPolygon.new() var vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) polygon.vertices = vertices - var indices = PackedInt32Array(0, 3, 1) + var indices = PackedInt32Array([0, 1, 2, 3]) polygon.add_polygon(indices) $NavigationRegion2D.navpoly = polygon [/gdscript] @@ -36,7 +36,7 @@ var polygon = new NavigationPolygon(); var vertices = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; polygon.Vertices = vertices; - var indices = new int[] { 0, 3, 1 }; + var indices = new int[] { 0, 1, 2, 3 }; polygon.AddPolygon(indices); GetNode<NavigationRegion2D>("NavigationRegion2D").Navpoly = polygon; [/csharp] diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 1740093eb2..971d3839f2 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -8,7 +8,7 @@ Maps are made up of regions, which are made of navigation polygons. Together, they define the navigable areas in the 2D world. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer2D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects. To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity. - [b]Note:[/b] the collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. + [b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. </description> <tutorials> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 3e10657838..16eba8bba8 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -8,7 +8,7 @@ Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer3D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. This allows allowing or forbidding some areas to 3D objects. To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity. - [b]Note:[/b] the collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. + [b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine. This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying. </description> <tutorials> @@ -234,7 +234,7 @@ <description> Process the collision avoidance agents. The result of this process is needed by the physics server, so this must be called in the main thread. - Note: This function is not thread safe. + [b]Note:[/b] This function is not thread safe. </description> </method> <method name="region_bake_navmesh" qualifiers="const"> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 77fd9165bb..636ed368d1 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -68,11 +68,11 @@ </constant> <constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode"> Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges. - [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. + [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. </constant> <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode"> Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than [constant AXIS_STRETCH_MODE_STRETCH]. The texture must be seamless for this to work without displaying artifacts between edges. - [b]Note:[/b] Only supported when using the GLES3 renderer. When using the GLES2 renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. + [b]Note:[/b] Only supported when using the Vulkan renderer. When using the OpenGL renderer, this will behave like [constant AXIS_STRETCH_MODE_STRETCH]. </constant> </constants> </class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index b4edcf49f4..f1ab5e4843 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -17,7 +17,7 @@ [b]Networking with nodes:[/b] After connecting to a server (or making one, see [ENetMultiplayerPeer]), it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling [method rpc] with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call, Godot will use its [NodePath] (make sure node names are the same on all peers). Also, take a look at the high-level networking tutorial and corresponding demos. </description> <tutorials> - <link title="Scenes and nodes">https://docs.godotengine.org/en/latest/getting_started/step_by_step/scenes_and_nodes.html</link> + <link title="Nodes and scenes">$DOCS_URL/getting_started/step_by_step/nodes_and_scenes.html</link> <link title="All Demos">https://github.com/godotengine/godot-demo-projects/</link> </tutorials> <methods> @@ -228,16 +228,19 @@ If [code]include_internal[/code] is [code]false[/code], the returned array won't include internal children (see [code]internal[/code] parameter in [method add_child]). </description> </method> - <method name="get_editor_description" qualifiers="const"> - <return type="String" /> - <description> - </description> - </method> <method name="get_groups" qualifiers="const"> <return type="Array" /> <description> Returns an array listing the groups that the node is a member of. [b]Note:[/b] For performance reasons, the order of node groups is [i]not[/i] guaranteed. The order of node groups should not be relied upon as it can vary across project runs. + [b]Note:[/b] The engine uses some group names internally (all starting with an underscore). To avoid conflicts with internal groups, do not add custom groups whose name starts with an underscore. To exclude internal groups while looping over [method get_groups], use the following snippet: + [codeblock] + # Stores the node's non-internal groups only (as an array of Strings). + var non_internal_groups = [] + for group in get_groups(): + if not group.begins_with("_"): + non_internal_groups.push_back(group) + [/codeblock] </description> </method> <method name="get_index" qualifiers="const"> @@ -258,7 +261,7 @@ <return type="Node" /> <argument index="0" name="path" type="NodePath" /> <description> - Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, [code]null[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). [b]Example:[/b] Assume your current node is Character and the following tree: [codeblock] @@ -319,7 +322,7 @@ <method name="get_parent" qualifiers="const"> <return type="Node" /> <description> - Returns the parent node of the current node, or a [code]null instance[/code] if the node lacks a parent. + Returns the parent node of the current node, or [code]null[/code] if the node lacks a parent. </description> </method> <method name="get_path" qualifiers="const"> @@ -551,6 +554,7 @@ <argument index="0" name="node" type="Node" /> <description> Removes a child node. The node is NOT deleted and must be deleted manually. + [b]Note:[/b] This function may set the [member owner] of the removed Node (or its descendants) to be [code]null[/code], if that [member owner] is no longer a parent or ancestor. </description> </method> <method name="remove_from_group"> @@ -567,6 +571,7 @@ <description> Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. If [code]keep_groups[/code] is [code]true[/code], the [code]node[/code] is added to the same groups that the replaced node is in. + Note that the replaced node is not automatically freed, so you either need to keep it in a variable for later use or free it using [method Object.free]. </description> </method> <method name="request_ready"> @@ -587,8 +592,9 @@ <return type="int" /> <argument index="0" name="method" type="StringName" /> <argument index="1" name="rpc_mode" type="int" enum="RPCMode" /> - <argument index="2" name="transfer_mode" type="int" enum="TransferMode" default="2" /> - <argument index="3" name="channel" type="int" default="0" /> + <argument index="2" name="call_local" type="bool" default="false" /> + <argument index="3" name="transfer_mode" type="int" enum="TransferMode" default="2" /> + <argument index="4" name="channel" type="int" default="0" /> <description> Changes the RPC mode for the given [code]method[/code] to the given [code]rpc_mode[/code], optionally specifying the [code]transfer_mode[/code] and [code]channel[/code] (on supported peers). See [enum RPCMode] and [enum TransferMode]. An alternative is annotating methods and properties with the corresponding annotation ([code]@rpc(any)[/code], [code]@rpc(auth)[/code]). By default, methods are not exposed to networking (and RPCs). </description> @@ -616,12 +622,6 @@ Sets the editable children state of [code]node[/code] relative to this node. This method is only intended for use with editor tooling. </description> </method> - <method name="set_editor_description"> - <return type="void" /> - <argument index="0" name="editor_description" type="String" /> - <description> - </description> - </method> <method name="set_multiplayer_authority"> <return type="void" /> <argument index="0" name="id" type="int" /> @@ -700,6 +700,9 @@ <member name="custom_multiplayer" type="MultiplayerAPI" setter="set_custom_multiplayer" getter="get_custom_multiplayer"> The override to the default [MultiplayerAPI]. Set to [code]null[/code] to use the default [SceneTree] one. </member> + <member name="editor_description" type="String" setter="set_editor_description" getter="get_editor_description" default=""""> + Add a custom description to a node. + </member> <member name="multiplayer" type="MultiplayerAPI" setter="" getter="get_multiplayer"> The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree). </member> @@ -788,8 +791,8 @@ <constant name="NOTIFICATION_DRAG_END" value="22"> Notification received when a drag ends. </constant> - <constant name="NOTIFICATION_PATH_CHANGED" value="23"> - Notification received when the node's [NodePath] changed. + <constant name="NOTIFICATION_PATH_RENAMED" value="23"> + Notification received when the node's name or one of its parents' name is changed. This notification is [i]not[/i] received when the node is removed from the scene tree to be added to another parent later on. </constant> <constant name="NOTIFICATION_INTERNAL_PROCESS" value="25"> Notification received every frame when the internal process flag is set (see [method set_process_internal]). diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index ef5f9ee5c9..b8bf342680 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -7,7 +7,7 @@ A 2D game object, with a transform (position, rotation, and scale). All 2D nodes, including physics objects and sprites, inherit from Node2D. Use Node2D as a parent node to move, scale and rotate children in a 2D project. Also gives control of the node's render order. </description> <tutorials> - <link title="Custom drawing in 2D">https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link> + <link title="Custom drawing in 2D">$DOCS_URL/tutorials/2d/custom_drawing_in_2d.html</link> <link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link> </tutorials> <methods> diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index 49901dc4d9..1036c1fbcf 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -9,7 +9,7 @@ [b]Note:[/b] Unless otherwise specified, all methods that have angle parameters must have angles specified as [i]radians[/i]. To convert degrees to radians, use [method @GlobalScope.deg2rad]. </description> <tutorials> - <link title="Introduction to 3D">https://docs.godotengine.org/en/latest/tutorials/3d/introduction_to_3d.html</link> + <link title="Introduction to 3D">$DOCS_URL/tutorials/3d/introduction_to_3d.html</link> <link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link> </tutorials> <methods> @@ -212,6 +212,15 @@ Sets whether the node notifies about its global and local transformation changes. [Node3D] will not propagate this by default, unless it is in the editor context and it has a valid gizmo. </description> </method> + <method name="set_subgizmo_selection"> + <return type="void" /> + <argument index="0" name="gizmo" type="Node3DGizmo" /> + <argument index="1" name="id" type="int" /> + <argument index="2" name="transform" type="Transform3D" /> + <description> + Set subgizmo selection for this node in the editor. + </description> + </method> <method name="show"> <return type="void" /> <description> @@ -255,16 +264,28 @@ </method> </methods> <members> + <member name="basis" type="Basis" setter="set_basis" getter="get_basis"> + Direct access to the 3x3 basis of the [Transform3D] property. + </member> <member name="global_transform" type="Transform3D" setter="set_global_transform" getter="get_global_transform"> World3D space (global) [Transform3D] of this node. </member> <member name="position" type="Vector3" setter="set_position" getter="get_position" default="Vector3(0, 0, 0)"> Local position or translation of this node relative to the parent. This is equivalent to [code]transform.origin[/code]. </member> + <member name="quaternion" type="Quaternion" setter="set_quaternion" getter="get_quaternion"> + Access to the node rotation as a [Quaternion]. This property is ideal for tweening complex rotations. + </member> <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation" default="Vector3(0, 0, 0)"> - Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). + Rotation part of the local transformation in radians, specified in terms of Euler angles. The angles construct a rotaton in the order specified by the [member rotation_order] property. [b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. </member> + <member name="rotation_edit_mode" type="int" setter="set_rotation_edit_mode" getter="get_rotation_edit_mode" enum="Node3D.RotationEditMode" default="0"> + Specify how rotation (and scale) will be presented in the editor. + </member> + <member name="rotation_order" type="int" setter="set_rotation_order" getter="get_rotation_order" enum="Node3D.RotationOrder" default="2"> + Specify the axis rotation order of the [member rotation] property. The final orientation is constructed by rotating the Euler angles in the order specified by this property. + </member> <member name="scale" type="Vector3" setter="set_scale" getter="get_scale" default="Vector3(1, 1, 1)"> Scale part of the local transformation. </member> @@ -302,5 +323,23 @@ <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43"> Node3D nodes receives this notification when their visibility changes. </constant> + <constant name="ROTATION_EDIT_MODE_EULER" value="0" enum="RotationEditMode"> + </constant> + <constant name="ROTATION_EDIT_MODE_QUATERNION" value="1" enum="RotationEditMode"> + </constant> + <constant name="ROTATION_EDIT_MODE_BASIS" value="2" enum="RotationEditMode"> + </constant> + <constant name="ROTATION_ORDER_XYZ" value="0" enum="RotationOrder"> + </constant> + <constant name="ROTATION_ORDER_XZY" value="1" enum="RotationOrder"> + </constant> + <constant name="ROTATION_ORDER_YXZ" value="2" enum="RotationOrder"> + </constant> + <constant name="ROTATION_ORDER_YZX" value="3" enum="RotationOrder"> + </constant> + <constant name="ROTATION_ORDER_ZXY" value="4" enum="RotationOrder"> + </constant> + <constant name="ROTATION_ORDER_ZYX" value="5" enum="RotationOrder"> + </constant> </constants> </class> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 17c6ba38b7..e2772a3ee0 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -25,21 +25,21 @@ <tutorials> <link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link> </tutorials> - <methods> - <method name="NodePath" qualifiers="constructor"> + <constructors> + <constructor name="NodePath"> <return type="NodePath" /> <description> Constructs an empty [NodePath]. </description> - </method> - <method name="NodePath" qualifiers="constructor"> + </constructor> + <constructor name="NodePath"> <return type="NodePath" /> <argument index="0" name="from" type="NodePath" /> <description> Constructs a [NodePath] as a copy of the given [NodePath]. </description> - </method> - <method name="NodePath" qualifiers="constructor"> + </constructor> + <constructor name="NodePath"> <return type="NodePath" /> <argument index="0" name="from" type="String" /> <description> @@ -61,7 +61,9 @@ "/root/Level/Path2D" [/codeblock] </description> - </method> + </constructor> + </constructors> + <methods> <method name="get_as_property_path" qualifiers="const"> <return type="NodePath" /> <description> @@ -166,27 +168,29 @@ Returns [code]true[/code] if the node path is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="NodePath" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="NodePath" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 9d0d185c42..7088844547 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -31,12 +31,21 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> + <method name="create_instance"> + <return type="int" /> + <argument index="0" name="arguments" type="PackedStringArray" /> + <description> + Creates a new instance of Godot that runs independently. The [code]arguments[/code] are used in the given order and separated by a space. + If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. + [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. + </description> + </method> <method name="create_process"> <return type="int" /> <argument index="0" name="path" type="String" /> <argument index="1" name="arguments" type="PackedStringArray" /> <description> - Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. + Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. For example, running another instance of the project: [codeblocks] @@ -49,7 +58,7 @@ [/codeblocks] See [method execute] if you wish to run an external command and retrieve the results. [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. - [b]Note:[/b] On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export. + [b]Note:[/b] On macOS, sandboxed applications are limited to run only embedded helper executables, specified during export or system .app bundle, system .app bundles will ignore arguments. </description> </method> <method name="delay_msec" qualifiers="const"> @@ -57,7 +66,7 @@ <argument index="0" name="msec" type="int" /> <description> Delays execution of the current thread by [code]msec[/code] milliseconds. [code]msec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_msec] will do nothing and will print an error message. - [b]Note:[/b] [method delay_msec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Yielding with [method SceneTree.create_timer] will delay the execution of code placed below the [code]yield[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). + [b]Note:[/b] [method delay_msec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). [b]Note:[/b] When [method delay_msec] is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using [method delay_msec] as part of an [EditorPlugin] or [EditorScript], it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process). </description> </method> @@ -66,7 +75,7 @@ <argument index="0" name="usec" type="int" /> <description> Delays execution of the current thread by [code]usec[/code] microseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_usec] will do nothing and will print an error message. - [b]Note:[/b] [method delay_usec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Yielding with [method SceneTree.create_timer] will delay the execution of code placed below the [code]yield[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). + [b]Note:[/b] [method delay_usec] is a [i]blocking[/i] way to delay code execution. To delay code execution in a non-blocking way, see [method SceneTree.create_timer]. Awaiting with [method SceneTree.create_timer] will delay the execution of code placed below the [code]await[/code] without affecting the rest of the project (or editor, for [EditorPlugin]s and [EditorScript]s). [b]Note:[/b] When [method delay_usec] is called on the main thread, it will freeze the project and will prevent it from redrawing and registering input until the delay has passed. When using [method delay_usec] as part of an [EditorPlugin] or [EditorScript], it will freeze the editor but won't freeze the project if it is currently running (since the project is an independent child process). </description> </method> @@ -124,7 +133,7 @@ </description> </method> <method name="find_keycode_from_string" qualifiers="const"> - <return type="int" /> + <return type="int" enum="Key" /> <argument index="0" name="string" type="String" /> <description> Returns the keycode of the given string (e.g. "Escape"). @@ -133,7 +142,7 @@ <method name="get_cache_dir" qualifiers="const"> <return type="String" /> <description> - Returns the [i]global[/i] cache data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_CACHE_HOME[/code] environment variable before starting the project. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_config_dir] and [method get_data_dir]. + Returns the [i]global[/i] cache data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_CACHE_HOME[/code] environment variable before starting the project. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_config_dir] and [method get_data_dir]. Not to be confused with [method get_user_data_dir], which returns the [i]project-specific[/i] user data path. </description> </method> @@ -170,7 +179,7 @@ <method name="get_config_dir" qualifiers="const"> <return type="String" /> <description> - Returns the [i]global[/i] user configuration directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_CONFIG_HOME[/code] environment variable before starting the project. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_cache_dir] and [method get_data_dir]. + Returns the [i]global[/i] user configuration directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_CONFIG_HOME[/code] environment variable before starting the project. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_cache_dir] and [method get_data_dir]. Not to be confused with [method get_user_data_dir], which returns the [i]project-specific[/i] user data path. </description> </method> @@ -185,7 +194,7 @@ <method name="get_data_dir" qualifiers="const"> <return type="String" /> <description> - Returns the [i]global[/i] user data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_DATA_HOME[/code] environment variable before starting the project. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_cache_dir] and [method get_config_dir]. + Returns the [i]global[/i] user data directory according to the operating system's standards. On desktop platforms, this path can be overridden by setting the [code]XDG_DATA_HOME[/code] environment variable before starting the project. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] in the documentation for more information. See also [method get_cache_dir] and [method get_config_dir]. Not to be confused with [method get_user_data_dir], which returns the [i]project-specific[/i] user data path. </description> </method> @@ -201,6 +210,7 @@ <return type="String" /> <description> Returns the path to the current engine executable. + [b]Note:[/b] On macOS, always use [method create_instance] instead of relying on executable path. </description> </method> <method name="get_granted_permissions" qualifiers="const"> @@ -212,7 +222,7 @@ </method> <method name="get_keycode_string" qualifiers="const"> <return type="String" /> - <argument index="0" name="code" type="int" /> + <argument index="0" name="code" type="int" enum="Key" /> <description> Returns the given keycode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). See also [member InputEventKey.keycode] and [method InputEventKey.get_keycode_with_modifiers]. @@ -236,6 +246,13 @@ This can be used to narrow down fully specified locale strings to only the "common" language code, when you don't need the additional information about country code or variants. For example, for a French Canadian user with [code]fr_CA[/code] locale, this would return [code]fr[/code]. </description> </method> + <method name="get_main_thread_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the ID of the main thread. See [method get_thread_caller_id]. + [b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts. + </description> + </method> <method name="get_model_name" qualifiers="const"> <return type="String" /> <description> @@ -246,7 +263,7 @@ <method name="get_name" qualifiers="const"> <return type="String" /> <description> - Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"OSX"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. + Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"macOS"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. </description> </method> <method name="get_process_id" qualifiers="const"> @@ -322,7 +339,7 @@ <return type="bool" /> <argument index="0" name="tag_name" type="String" /> <description> - Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=https://docs.godotengine.org/en/latest/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. + Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=$DOCS_URL/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. [b]Note:[/b] Tag names are case-sensitive. </description> </method> @@ -455,11 +472,11 @@ </member> </members> <constants> - <constant name="VIDEO_DRIVER_GLES2" value="0" enum="VideoDriver"> - The GLES2 rendering backend. It uses OpenGL ES 2.0 on mobile devices, OpenGL 2.1 on desktop platforms and WebGL 1.0 on the web. + <constant name="VIDEO_DRIVER_VULKAN" value="0" enum="VideoDriver"> + The Vulkan rendering backend. It requires Vulkan 1.0 support and automatically uses features from Vulkan 1.1 and 1.2 if available. </constant> - <constant name="VIDEO_DRIVER_VULKAN" value="1" enum="VideoDriver"> - The Vulkan rendering backend. + <constant name="VIDEO_DRIVER_OPENGL_3" value="1" enum="VideoDriver"> + The OpenGL 3 rendering backend. It uses OpenGL 3.3 Core Profile on desktop platforms, OpenGL ES 3.0 on mobile devices, and WebGL 2.0 on HTML5. </constant> <constant name="DAY_SUNDAY" value="0" enum="Weekday"> Sunday. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index ed045f8390..860e252805 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -29,7 +29,7 @@ [b]Note:[/b] Unlike references to a [RefCounted], references to an Object stored in a variable can become invalid without warning. Therefore, it's recommended to use [RefCounted] for data classes instead of [Object]. </description> <tutorials> - <link title="When and how to avoid using nodes for everything">https://docs.godotengine.org/en/latest/getting_started/workflow/best_practices/node_alternatives.html</link> + <link title="When and how to avoid using nodes for everything">$DOCS_URL/tutorials/best_practices/node_alternatives.html</link> </tutorials> <methods> <method name="_get" qualifiers="virtual"> @@ -350,6 +350,7 @@ <argument index="0" name="property" type="NodePath" /> <description> Gets the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. + [b]Note:[/b] Even though the method takes [NodePath] argument, it doesn't support actual paths to [Node]s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use [method Node.get_node_and_resource] instead. </description> </method> <method name="get_instance_id" qualifiers="const"> @@ -567,7 +568,7 @@ <description> Translates a message using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. - See [url=https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html]Internationalizing games[/url] for examples of the usage of this method. + See [url=$DOCS_URL/tutorials/i18n/internationalizing_games.html]Internationalizing games[/url] for examples of the usage of this method. </description> </method> <method name="tr_n" qualifiers="const"> @@ -581,7 +582,7 @@ Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] or [code]plural_message[/code] unchanged. See [method set_message_translation]. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. [b]Note:[/b] Negative and floating-point values usually represent physical entities for which singular and plural don't clearly apply. In such cases, use [method tr]. - See [url=https://docs.godotengine.org/en/latest/tutorials/i18n/localization_using_gettext.html]Localization using gettext[/url] for examples of the usage of this method. + See [url=$DOCS_URL/tutorials/i18n/localization_using_gettext.html]Localization using gettext[/url] for examples of the usage of this method. </description> </method> </methods> diff --git a/doc/classes/OmniLight3D.xml b/doc/classes/OmniLight3D.xml index e8d5977199..013ad0cc42 100644 --- a/doc/classes/OmniLight3D.xml +++ b/doc/classes/OmniLight3D.xml @@ -7,7 +7,7 @@ An Omnidirectional light is a type of [Light3D] that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. </description> <tutorials> - <link title="3D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> + <link title="3D lights and shadows">$DOCS_URL/tutorials/3d/lights_and_shadows.html</link> </tutorials> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param" default="1.0"> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 264ef9975a..a3616af999 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -84,6 +84,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_selected_id" qualifiers="const"> @@ -208,6 +209,9 @@ <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> Text [Color] used when the [OptionButton] is disabled. </theme_item> + <theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> + Text [Color] used when the [OptionButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color. + </theme_item> <theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> Text [Color] used when the [OptionButton] is being hovered. </theme_item> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 28508c85e0..b5e7b32225 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -43,8 +43,8 @@ <method name="pck_start"> <return type="int" enum="Error" /> <argument index="0" name="pck_name" type="String" /> - <argument index="1" name="alignment" type="int" default="0" /> - <argument index="2" name="key" type="String" default="""" /> + <argument index="1" name="alignment" type="int" default="32" /> + <argument index="2" name="key" type="String" default=""0000000000000000000000000000000000000000000000000000000000000000"" /> <argument index="3" name="encrypt_directory" type="bool" default="false" /> <description> Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required). diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 39733baf40..fd098481e4 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedByteArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <description> Constructs an empty [PackedByteArray]. </description> - </method> - <method name="PackedByteArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <argument index="0" name="from" type="PackedByteArray" /> <description> Constructs a [PackedByteArray] as a copy of the given [PackedByteArray]. </description> - </method> - <method name="PackedByteArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedByteArray"> <return type="PackedByteArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -323,40 +325,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedByteArray" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedByteArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -364,7 +332,7 @@ Appends an element at the end of the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -445,4 +413,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedByteArray" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedByteArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 00e670646d..f69c5504da 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedColorArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <description> Constructs an empty [PackedColorArray]. </description> - </method> - <method name="PackedColorArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <argument index="0" name="from" type="PackedColorArray" /> <description> Constructs a [PackedColorArray] as a copy of the given [PackedColorArray]. </description> - </method> - <method name="PackedColorArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedColorArray"> <return type="PackedColorArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedColorArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Color" /> @@ -86,40 +88,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedColorArray" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedColorArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Color" /> @@ -127,7 +95,7 @@ Appends a value to the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -180,4 +148,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedColorArray" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedColorArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Color" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 2ee2ac44df..ccac607386 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedFloat32Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <description> Constructs an empty [PackedFloat32Array]. </description> - </method> - <method name="PackedFloat32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <argument index="0" name="from" type="PackedFloat32Array" /> <description> Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array]. </description> - </method> - <method name="PackedFloat32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat32Array"> <return type="PackedFloat32Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedFloat32Array" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat32Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -128,7 +96,7 @@ Appends an element at the end of the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedFloat32Array" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 7414bc72fc..b164283b3e 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedFloat64Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <description> Constructs an empty [PackedFloat64Array]. </description> - </method> - <method name="PackedFloat64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <argument index="0" name="from" type="PackedFloat64Array" /> <description> Constructs a [PackedFloat64Array] as a copy of the given [PackedFloat64Array]. </description> - </method> - <method name="PackedFloat64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedFloat64Array"> <return type="PackedFloat64Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedFloat64Array" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedFloat64Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="float" /> @@ -128,7 +96,7 @@ Appends an element at the end of the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedFloat64Array" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat64Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index 8ecf4a70ae..c6ff31ebdd 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedInt32Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <description> Constructs an empty [PackedInt32Array]. </description> - </method> - <method name="PackedInt32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <argument index="0" name="from" type="PackedInt32Array" /> <description> Constructs a [PackedInt32Array] as a copy of the given [PackedInt32Array]. </description> - </method> - <method name="PackedInt32Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt32Array"> <return type="PackedInt32Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedInt32Array" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt32Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -128,7 +96,7 @@ Appends a value to the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedInt32Array" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt32Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index b82ce79009..ff48eb1aad 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -9,27 +9,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedInt64Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <description> Constructs an empty [PackedInt64Array]. </description> - </method> - <method name="PackedInt64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <argument index="0" name="from" type="PackedInt64Array" /> <description> Constructs a [PackedInt64Array] as a copy of the given [PackedInt64Array]. </description> - </method> - <method name="PackedInt64Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedInt64Array"> <return type="PackedInt64Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedInt64Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedInt64Array" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedInt64Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="int" /> @@ -128,7 +96,7 @@ Appends a value to the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -183,4 +151,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedInt64Array" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedInt64Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 618123855f..d3a770b35b 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -5,7 +5,7 @@ </brief_description> <description> A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself. - Can be used to save a node to a file. When saving, the node as well as all the nodes it owns get saved (see [code]owner[/code] property on [Node]). + Can be used to save a node to a file. When saving, the node as well as all the nodes it owns get saved (see [member Node.owner] property). [b]Note:[/b] The node doesn't need to own itself. [b]Example of loading a saved scene:[/b] [codeblocks] @@ -22,7 +22,7 @@ AddChild(scene); [/csharp] [/codeblocks] - [b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidDynamicBody2D[/code] ([code]body[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]body[/code] which is a child of [code]node[/code]. Only [code]body[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. + [b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [Node2D] ([code]node[/code]), [RigidDynamicBody2D] ([code]body[/code]) and [CollisionObject2D] ([code]collision[/code]). [code]collision[/code] is a child of [code]body[/code] which is a child of [code]node[/code]. Only [code]body[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. [codeblocks] [gdscript] # Create the objects. @@ -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/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 353bbfb827..4204277ea2 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -9,27 +9,29 @@ <tutorials> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> - <methods> - <method name="PackedStringArray" qualifiers="constructor"> + <constructors> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <description> Constructs an empty [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <argument index="0" name="from" type="PackedStringArray" /> <description> Constructs a [PackedStringArray] as a copy of the given [PackedStringArray]. </description> - </method> - <method name="PackedStringArray" qualifiers="constructor"> + </constructor> + <constructor name="PackedStringArray"> <return type="PackedStringArray" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedStringArray]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="String" /> @@ -87,40 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedStringArray" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedStringArray" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="String" /> @@ -128,7 +96,7 @@ Appends a string element at end of the array. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -181,4 +149,40 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedStringArray" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedStringArray" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="String" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 7b7df221e7..e6a7b2fa41 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -9,27 +9,29 @@ <tutorials> <link title="2D Navigation Astar Demo">https://godotengine.org/asset-library/asset/519</link> </tutorials> - <methods> - <method name="PackedVector2Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <description> Constructs an empty [PackedVector2Array]. </description> - </method> - <method name="PackedVector2Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <argument index="0" name="from" type="PackedVector2Array" /> <description> Constructs a [PackedVector2Array] as a copy of the given [PackedVector2Array]. </description> - </method> - <method name="PackedVector2Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector2Array"> <return type="PackedVector2Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Vector2" /> @@ -87,46 +89,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Vector2" /> @@ -134,7 +96,7 @@ Inserts a [Vector2] at the end. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -187,4 +149,46 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index efbf2169fd..6992bbca01 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -8,27 +8,29 @@ </description> <tutorials> </tutorials> - <methods> - <method name="PackedVector3Array" qualifiers="constructor"> + <constructors> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <description> Constructs an empty [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="PackedVector3Array" /> <description> Constructs a [PackedVector3Array] as a copy of the given [PackedVector3Array]. </description> - </method> - <method name="PackedVector3Array" qualifiers="constructor"> + </constructor> + <constructor name="PackedVector3Array"> <return type="PackedVector3Array" /> <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> @@ -86,46 +88,6 @@ Returns [code]true[/code] if the array is empty. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="push_back"> <return type="bool" /> <argument index="0" name="value" type="Vector3" /> @@ -133,7 +95,7 @@ Inserts a [Vector3] at the end. </description> </method> - <method name="remove"> + <method name="remove_at"> <return type="void" /> <argument index="0" name="index" type="int" /> <description> @@ -186,4 +148,46 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="Vector3" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 9b77859b50..31640eb3d8 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -74,7 +74,7 @@ <description> Joins the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. - Note: Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission for multicast to work. + [b]Note:[/b] Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission for multicast to work. </description> </method> <method name="leave_multicast_group"> @@ -90,7 +90,7 @@ <argument index="0" name="enabled" type="bool" /> <description> Enable or disable sending of broadcast packets (e.g. [code]set_dest_address("255.255.255.255", 4343)[/code]. This option is disabled by default. - Note: Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission and this option to be enabled to receive broadcast packets too. + [b]Note:[/b] Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission and this option to be enabled to receive broadcast packets too. </description> </method> <method name="set_dest_address"> @@ -99,7 +99,7 @@ <argument index="1" name="port" type="int" /> <description> Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. - Note: [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. [code]255.255.255.255[/code]). + [b]Note:[/b] [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. [code]255.255.255.255[/code]). </description> </method> <method name="wait"> 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/PhysicalBone3D.xml b/doc/classes/PhysicalBone3D.xml index 710e96239b..a9963d59e8 100644 --- a/doc/classes/PhysicalBone3D.xml +++ b/doc/classes/PhysicalBone3D.xml @@ -37,8 +37,12 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps the body's rotation if greater than [code]0[/code]. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. + See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. + </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="PhysicalBone3D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. </member> <member name="body_offset" type="Transform3D" setter="set_body_offset" getter="get_body_offset" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> Sets the body's transform. @@ -64,14 +68,24 @@ <member name="joint_type" type="int" setter="set_joint_type" getter="get_joint_type" enum="PhysicalBone3D.JointType" default="0"> Sets the joint type. See [enum JointType] for possible values. </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - Damps the body's movement if greater than [code]0[/code]. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. + See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. + </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="PhysicalBone3D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. </member> <member name="mass" type="float" setter="set_mass" getter="get_mass" default="1.0"> The body's mass. </member> </members> <constants> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> <constant name="JOINT_TYPE_NONE" value="0" enum="JointType"> </constant> <constant name="JOINT_TYPE_PIN" value="1" enum="JointType"> diff --git a/doc/classes/PhysicalSkyMaterial.xml b/doc/classes/PhysicalSkyMaterial.xml index b90f52a70d..e1e50a2b51 100644 --- a/doc/classes/PhysicalSkyMaterial.xml +++ b/doc/classes/PhysicalSkyMaterial.xml @@ -23,7 +23,7 @@ <member name="mie_coefficient" type="float" setter="set_mie_coefficient" getter="get_mie_coefficient" default="0.005"> Controls the strength of mie scattering for the sky. Mie scattering results from light colliding with larger particles (like water). On earth, mie scattering results in a whitish color around the sun and horizon. </member> - <member name="mie_color" type="Color" setter="set_mie_color" getter="get_mie_color" default="Color(0.36, 0.56, 0.82, 1)"> + <member name="mie_color" type="Color" setter="set_mie_color" getter="get_mie_color" default="Color(0.63, 0.77, 0.92, 1)"> Controls the [Color] of the mie scattering effect. While not physically accurate, this allows for the creation of alien looking planets. </member> <member name="mie_eccentricity" type="float" setter="set_mie_eccentricity" getter="get_mie_eccentricity" default="0.8"> @@ -35,7 +35,7 @@ <member name="rayleigh_coefficient" type="float" setter="set_rayleigh_coefficient" getter="get_rayleigh_coefficient" default="2.0"> Controls the strength of the Rayleigh scattering. Rayleigh scattering results from light colliding with small particles. It is responsible for the blue color of the sky. </member> - <member name="rayleigh_color" type="Color" setter="set_rayleigh_color" getter="get_rayleigh_color" default="Color(0.056, 0.14, 0.3, 1)"> + <member name="rayleigh_color" type="Color" setter="set_rayleigh_color" getter="get_rayleigh_color" default="Color(0.26, 0.41, 0.58, 1)"> Controls the [Color] of the Rayleigh scattering. While not physically accurate, this allows for the creation of alien looking planets. For example, setting this to a red [Color] results in a Mars looking atmosphere with a corresponding blue sunset. </member> <member name="sun_disk_scale" type="float" setter="set_sun_disk_scale" getter="get_sun_disk_scale" default="1.0"> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index e108ab6298..08f9de53ca 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -7,7 +7,7 @@ PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> </tutorials> <methods> <method name="add_collision_exception_with"> @@ -30,7 +30,7 @@ <argument index="2" name="safe_margin" type="float" default="0.08" /> <description> Moves the body along the vector [code]linear_velocity[/code]. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision. + The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision when stopped, or when touching another body along the motion. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody2D.collision/safe_margin] for more details). </description> @@ -50,8 +50,8 @@ <argument index="3" name="safe_margin" type="float" default="0.08" /> <description> Checks for collisions without moving the body. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would occur. - [code]collision[/code] is an optional object of type [KinematicCollision2D], which contains additional information about the collision (should there be one). + Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. + [code]collision[/code] is an optional object of type [KinematicCollision2D], which contains additional information about the collision when stopped, or when touching another body along the motion. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody2D.collision/safe_margin] for more details). </description> </method> diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml index 8718c0caa2..3c52850eec 100644 --- a/doc/classes/PhysicsBody3D.xml +++ b/doc/classes/PhysicsBody3D.xml @@ -7,7 +7,7 @@ PhysicsBody3D is an abstract base class for implementing a physics body. All *Body types inherit from it. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> </tutorials> <methods> <method name="add_collision_exception_with"> @@ -38,7 +38,7 @@ <argument index="3" name="max_collisions" type="int" default="1" /> <description> Moves the body along the vector [code]linear_velocity[/code]. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision. + The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details). [code]max_collisions[/code] allows to retrieve more than one collision result. @@ -68,8 +68,8 @@ <argument index="4" name="max_collisions" type="int" default="1" /> <description> Checks for collisions without moving the body. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would occur. - [code]collision[/code] is an optional object of type [KinematicCollision3D], which contains additional information about the collision (should there be one). + Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. + [code]collision[/code] is an optional object of type [KinematicCollision3D], which contains additional information about the collision when stopped, or when touching another body along the motion. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details). [code]max_collisions[/code] allows to retrieve more than one collision result. </description> diff --git a/doc/classes/PhysicsDirectBodyState2D.xml b/doc/classes/PhysicsDirectBodyState2D.xml index aa189f17f4..c33bd930be 100644 --- a/doc/classes/PhysicsDirectBodyState2D.xml +++ b/doc/classes/PhysicsDirectBodyState2D.xml @@ -7,8 +7,8 @@ Provides direct access to a physics body in the [PhysicsServer2D], allowing safe changes to physics properties. This object is passed via the direct state callback of dynamic bodies, and is intended for changing the direct state of that body. See [method RigidDynamicBody2D._integrate_forces]. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <methods> <method name="add_central_force"> @@ -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..7aa46dec2f 100644 --- a/doc/classes/PhysicsDirectBodyState3D.xml +++ b/doc/classes/PhysicsDirectBodyState3D.xml @@ -7,8 +7,8 @@ Provides direct access to a physics body in the [PhysicsServer3D], allowing safe changes to physics properties. This object is passed via the direct state callback of dynamic bodies, and is intended for changing the direct state of that body. See [method RigidDynamicBody3D._integrate_forces]. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <methods> <method name="add_central_force"> @@ -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 9aa00022cd..fb82aaf36a 100644 --- a/doc/classes/PhysicsDirectSpaceState2D.xml +++ b/doc/classes/PhysicsDirectSpaceState2D.xml @@ -7,13 +7,13 @@ Direct access object to a space in the [PhysicsServer2D]. It's used mainly to do queries against objects and areas residing in a given space. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <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,15 +22,16 @@ </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. + Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in [PhysicsShapeQueryParameters2D] object, second one is in the collided shape from the physics space. </description> </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: @@ -44,68 +45,38 @@ </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. + [code]normal[/code]: The object's surface normal at the intersection point, or [code]Vector2(0, 0)[/code] if the ray starts inside the shape and [member PhysicsRayQueryParameters2D.hit_from_inside] is [code]true[/code]. [code]position[/code]: The intersection point. [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 137e7bbf39..177fca9ce3 100644 --- a/doc/classes/PhysicsDirectSpaceState3D.xml +++ b/doc/classes/PhysicsDirectSpaceState3D.xml @@ -7,14 +7,13 @@ Direct access object to a space in the [PhysicsServer3D]. It's used mainly to do queries against objects and areas residing in a given space. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <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,15 +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. @@ -41,31 +42,39 @@ [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. + [code]normal[/code]: The object's surface normal at the intersection point, or [code]Vector3(0, 0, 0)[/code] if the ray starts inside the shape and [member PhysicsRayQueryParameters3D.hit_from_inside] is [code]true[/code]. [code]position[/code]: The intersection point. [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: @@ -74,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..b4cb2145cf --- /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=$DOCS_URL/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..51e8f8c5b4 --- /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=$DOCS_URL/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..7e317c18bf --- /dev/null +++ b/doc/classes/PhysicsRayQueryParameters2D.xml @@ -0,0 +1,34 @@ +<?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=$DOCS_URL/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="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false"> + If [code]true[/code], the query will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector2(0, 0)[/code]. Does not affect concave polygon shapes. + </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..c378325a3c --- /dev/null +++ b/doc/classes/PhysicsRayQueryParameters3D.xml @@ -0,0 +1,37 @@ +<?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=$DOCS_URL/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="hit_back_faces" type="bool" setter="set_hit_back_faces" getter="is_hit_back_faces_enabled" default="true"> + If [code]true[/code], the query will hit back faces with concave polygon shapes with back face enabled or heightmap shapes. + </member> + <member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false"> + If [code]true[/code], the query will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector3(0, 0, 0)[/code]. Does not affect concave polygon shapes or heightmap shapes. + </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 b5b6a7ea58..868b58ea9f 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -98,13 +98,6 @@ Returns the space assigned to the area. </description> </method> - <method name="area_get_space_override_mode" qualifiers="const"> - <return type="int" enum="PhysicsServer2D.AreaSpaceOverrideMode" /> - <argument index="0" name="area" type="RID" /> - <description> - Returns the space override mode for the area. - </description> - </method> <method name="area_get_transform" qualifiers="const"> <return type="Transform2D" /> <argument index="0" name="area" type="RID" /> @@ -123,8 +116,7 @@ <method name="area_set_area_monitor_callback"> <return type="void" /> <argument index="0" name="area" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> + <argument index="1" name="callback" type="Callable" /> <description> </description> </method> @@ -147,8 +139,7 @@ <method name="area_set_monitor_callback"> <return type="void" /> <argument index="0" name="area" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> + <argument index="1" name="callback" type="Callable" /> <description> Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -209,14 +200,6 @@ Assigns a space to the area. </description> </method> - <method name="area_set_space_override_mode"> - <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer2D.AreaSpaceOverrideMode" /> - <description> - Sets the space override mode for the area. See [enum AreaSpaceOverrideMode] for a list of available modes. - </description> - </method> <method name="area_set_transform"> <return type="void" /> <argument index="0" name="area" type="RID" /> @@ -348,7 +331,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"> @@ -584,14 +567,10 @@ <method name="body_test_motion"> <return type="bool" /> <argument index="0" name="body" type="RID" /> - <argument index="1" name="from" type="Transform2D" /> - <argument index="2" name="motion" type="Vector2" /> - <argument index="3" name="margin" type="float" default="0.08" /> - <argument index="4" name="result" type="PhysicsTestMotionResult2D" default="null" /> - <argument index="5" name="collide_separation_ray" type="bool" default="false" /> - <argument index="6" name="exclude" type="Array" default="[]" /> + <argument index="1" name="parameters" type="PhysicsTestMotionParameters2D" /> + <argument index="2" name="result" type="PhysicsTestMotionResult2D" default="null" /> <description> - Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [PhysicsTestMotionResult2D] can be passed to return additional information in. + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters2D] is passed to set motion parameters. [PhysicsTestMotionResult2D] can be passed to return additional information. </description> </method> <method name="capsule_shape_create"> @@ -861,28 +840,37 @@ <constant name="SHAPE_CUSTOM" value="8" enum="ShapeType"> This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> - <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_OVERRIDE_MODE" value="0" enum="AreaParameter"> + Constant to set/get gravity override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + </constant> + <constant name="AREA_PARAM_GRAVITY" value="1" enum="AreaParameter"> Constant to set/get gravity strength in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="2" enum="AreaParameter"> Constant to set/get gravity vector/center in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="3" enum="AreaParameter"> Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> - <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="4" enum="AreaParameter"> Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="5" enum="AreaParameter"> This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE]. </constant> - <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> - Constant to set/get the linear dampening factor of an area. + <constant name="AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE" value="6" enum="AreaParameter"> + Constant to set/get linear damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + </constant> + <constant name="AREA_PARAM_LINEAR_DAMP" value="7" enum="AreaParameter"> + Constant to set/get the linear damping factor of an area. + </constant> + <constant name="AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE" value="8" enum="AreaParameter"> + Constant to set/get angular damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. </constant> - <constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter"> - Constant to set/get the angular dampening factor of an area. + <constant name="AREA_PARAM_ANGULAR_DAMP" value="9" enum="AreaParameter"> + Constant to set/get the angular damping factor of an area. </constant> - <constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter"> + <constant name="AREA_PARAM_PRIORITY" value="10" enum="AreaParameter"> Constant to set/get the priority (order of processing) of an area. </constant> <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode"> @@ -925,20 +913,32 @@ 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. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="6" enum="BodyParameter"> + <constant name="BODY_PARAM_LINEAR_DAMP_MODE" value="6" enum="BodyParameter"> + Constant to set/get a body's linear dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP_MODE" value="7" enum="BodyParameter"> + Constant to set/get a body's angular dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="8" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="7" enum="BodyParameter"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="9" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="8" enum="BodyParameter"> + <constant name="BODY_PARAM_MAX" value="10" enum="BodyParameter"> Represents the size of the [enum BodyParameter] enum. </constant> + <constant name="BODY_DAMP_MODE_COMBINE" value="0" enum="BodyDampMode"> + The body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="BODY_DAMP_MODE_REPLACE" value="1" enum="BodyDampMode"> + The body's damping value replaces any value set in areas or the default value. + </constant> <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 1d1ca54dbb..ceb3e788d2 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -85,13 +85,6 @@ Returns the space assigned to the area. </description> </method> - <method name="area_get_space_override_mode" qualifiers="const"> - <return type="int" enum="PhysicsServer3D.AreaSpaceOverrideMode" /> - <argument index="0" name="area" type="RID" /> - <description> - Returns the space override mode for the area. - </description> - </method> <method name="area_get_transform" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="area" type="RID" /> @@ -110,8 +103,7 @@ <method name="area_set_area_monitor_callback"> <return type="void" /> <argument index="0" name="area" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> + <argument index="1" name="callback" type="Callable" /> <description> </description> </method> @@ -134,8 +126,7 @@ <method name="area_set_monitor_callback"> <return type="void" /> <argument index="0" name="area" type="RID" /> - <argument index="1" name="receiver" type="Object" /> - <argument index="2" name="method" type="StringName" /> + <argument index="1" name="callback" type="Callable" /> <description> Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -203,14 +194,6 @@ Assigns a space to the area. </description> </method> - <method name="area_set_space_override_mode"> - <return type="void" /> - <argument index="0" name="area" type="RID" /> - <argument index="1" name="mode" type="int" enum="PhysicsServer3D.AreaSpaceOverrideMode" /> - <description> - Sets the space override mode for the area. The modes are described in the [enum AreaSpaceOverrideMode] constants. - </description> - </method> <method name="area_set_transform"> <return type="void" /> <argument index="0" name="area" type="RID" /> @@ -322,7 +305,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"> @@ -577,15 +560,10 @@ <method name="body_test_motion"> <return type="bool" /> <argument index="0" name="body" type="RID" /> - <argument index="1" name="from" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" default="0.001" /> - <argument index="4" name="result" type="PhysicsTestMotionResult3D" default="null" /> - <argument index="5" name="collide_separation_ray" type="bool" default="false" /> - <argument index="6" name="exclude" type="Array" default="[]" /> - <argument index="7" name="max_collisions" type="int" default="1" /> + <argument index="1" name="parameters" type="PhysicsTestMotionParameters3D" /> + <argument index="2" name="result" type="PhysicsTestMotionResult3D" default="null" /> <description> - Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [PhysicsTestMotionResult3D] can be passed to return additional information in. + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters3D] is passed to set motion parameters. [PhysicsTestMotionResult3D] can be passed to return additional information. </description> </method> <method name="box_shape_create"> @@ -1174,16 +1152,16 @@ Maximum acceleration for the motor at the axes. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="G6DOFJointAxisFlag"> - If [code]set[/code] there is linear motion possible within the given limits. + If set, linear motion is possible within the given limits. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="G6DOFJointAxisFlag"> - If [code]set[/code] there is rotational motion possible. + If set, rotational motion is possible. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="4" enum="G6DOFJointAxisFlag"> - If [code]set[/code] there is a rotational motor across these axes. + If set, there is a rotational motor across these axes. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_MOTOR" value="5" enum="G6DOFJointAxisFlag"> - If [code]set[/code] there is a linear motor on this axis that targets a specific velocity. + If set, there is a linear motor on this axis that targets a specific velocity. </constant> <constant name="SHAPE_WORLD_BOUNDARY" value="0" enum="ShapeType"> The [Shape3D] is a [WorldBoundaryShape3D]. @@ -1218,40 +1196,49 @@ <constant name="SHAPE_CUSTOM" value="10" enum="ShapeType"> This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> - <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_OVERRIDE_MODE" value="0" enum="AreaParameter"> + Constant to set/get gravity override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + </constant> + <constant name="AREA_PARAM_GRAVITY" value="1" enum="AreaParameter"> Constant to set/get gravity strength in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="2" enum="AreaParameter"> Constant to set/get gravity vector/center in an area. </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="3" enum="AreaParameter"> Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> - <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="4" enum="AreaParameter"> Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter"> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="5" enum="AreaParameter"> This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE]. </constant> - <constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter"> - Constant to set/get the linear dampening factor of an area. + <constant name="AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE" value="6" enum="AreaParameter"> + Constant to set/get linear damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + </constant> + <constant name="AREA_PARAM_LINEAR_DAMP" value="7" enum="AreaParameter"> + Constant to set/get the linear damping factor of an area. + </constant> + <constant name="AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE" value="8" enum="AreaParameter"> + Constant to set/get angular damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. </constant> - <constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter"> - Constant to set/get the angular dampening factor of an area. + <constant name="AREA_PARAM_ANGULAR_DAMP" value="9" enum="AreaParameter"> + Constant to set/get the angular damping factor of an area. </constant> - <constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter"> + <constant name="AREA_PARAM_PRIORITY" value="10" enum="AreaParameter"> Constant to set/get the priority (order of processing) of an area. </constant> - <constant name="AREA_PARAM_WIND_FORCE_MAGNITUDE" value="8" enum="AreaParameter"> + <constant name="AREA_PARAM_WIND_FORCE_MAGNITUDE" value="11" enum="AreaParameter"> Constant to set/get the magnitude of area-specific wind force. </constant> - <constant name="AREA_PARAM_WIND_SOURCE" value="9" enum="AreaParameter"> + <constant name="AREA_PARAM_WIND_SOURCE" value="12" enum="AreaParameter"> Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows. </constant> - <constant name="AREA_PARAM_WIND_DIRECTION" value="10" enum="AreaParameter"> + <constant name="AREA_PARAM_WIND_DIRECTION" value="13" enum="AreaParameter"> Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows. </constant> - <constant name="AREA_PARAM_WIND_ATTENUATION_FACTOR" value="11" enum="AreaParameter"> + <constant name="AREA_PARAM_WIND_ATTENUATION_FACTOR" value="14" enum="AreaParameter"> Constant to set/get the exponential rate at which wind force decreases with distance from its origin. </constant> <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode"> @@ -1294,20 +1281,32 @@ 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. </constant> - <constant name="BODY_PARAM_LINEAR_DAMP" value="6" enum="BodyParameter"> + <constant name="BODY_PARAM_LINEAR_DAMP_MODE" value="6" enum="BodyParameter"> + Constant to set/get a body's linear dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP_MODE" value="7" enum="BodyParameter"> + Constant to set/get a body's angular dampening mode. See [enum BodyDampMode] for possible values. + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="8" enum="BodyParameter"> Constant to set/get a body's linear dampening factor. </constant> - <constant name="BODY_PARAM_ANGULAR_DAMP" value="7" enum="BodyParameter"> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="9" enum="BodyParameter"> Constant to set/get a body's angular dampening factor. </constant> - <constant name="BODY_PARAM_MAX" value="8" enum="BodyParameter"> + <constant name="BODY_PARAM_MAX" value="10" enum="BodyParameter"> Represents the size of the [enum BodyParameter] enum. </constant> + <constant name="BODY_DAMP_MODE_COMBINE" value="0" enum="BodyDampMode"> + The body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="BODY_DAMP_MODE_REPLACE" value="1" enum="BodyDampMode"> + The body's damping value replaces any value set in areas or the default value. + </constant> <constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState"> Constant to set/get the current transform matrix of the body. </constant> diff --git a/doc/classes/PhysicsShapeQueryParameters2D.xml b/doc/classes/PhysicsShapeQueryParameters2D.xml index 6035b662ea..455f0b67dc 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> @@ -16,7 +16,7 @@ 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. + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=$DOCS_URL/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. diff --git a/doc/classes/PhysicsShapeQueryParameters3D.xml b/doc/classes/PhysicsShapeQueryParameters3D.xml index 1a289ff9d0..789ce0a6c3 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> @@ -16,7 +16,7 @@ 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. + The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See [url=$DOCS_URL/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. @@ -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/PhysicsTestMotionParameters2D.xml b/doc/classes/PhysicsTestMotionParameters2D.xml new file mode 100644 index 0000000000..46c1827b97 --- /dev/null +++ b/doc/classes/PhysicsTestMotionParameters2D.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsTestMotionParameters2D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 2D body motion test. + </brief_description> + <description> + This class contains parameters used in [method PhysicsServer2D.body_test_motion]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false"> + If set to [code]true[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. + If set to [code]false[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes. + </member> + <member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]"> + Optional array of body [RID] to exclude from collision. + </member> + <member name="exclude_objects" type="Array" setter="set_exclude_objects" getter="get_exclude_objects" default="[]"> + Optional array of object unique instance ID to exclude from collision. See [method Object.get_instance_id]. + </member> + <member name="from" type="Transform2D" setter="set_from" getter="get_from" default="Transform2D(1, 0, 0, 1, 0, 0)"> + Transform in global space where the motion should start. Usually set to [member Node2D.global_transform] for the current body's transform. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.08"> + Increases the size of the shapes involved in the collision detection. + </member> + <member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2(0, 0)"> + Motion vector to define the length and direction of the motion to test. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsTestMotionParameters3D.xml b/doc/classes/PhysicsTestMotionParameters3D.xml new file mode 100644 index 0000000000..d66aee3ae6 --- /dev/null +++ b/doc/classes/PhysicsTestMotionParameters3D.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsTestMotionParameters3D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 3D body motion test. + </brief_description> + <description> + This class contains parameters used in [method PhysicsServer3D.body_test_motion]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false"> + If set to [code]true[/code], shapes of type [constant PhysicsServer3D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. + If set to [code]false[/code], shapes of type [constant PhysicsServer3D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes. + </member> + <member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]"> + Optional array of body [RID] to exclude from collision. + </member> + <member name="exclude_objects" type="Array" setter="set_exclude_objects" getter="get_exclude_objects" default="[]"> + Optional array of object unique instance ID to exclude from collision. See [method Object.get_instance_id]. + </member> + <member name="from" type="Transform3D" setter="set_from" getter="get_from" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> + Transform in global space where the motion should start. Usually set to [member Node3D.global_transform] for the current body's transform. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.001"> + Increases the size of the shapes involved in the collision detection. + </member> + <member name="max_collisions" type="int" setter="set_max_collisions" getter="get_max_collisions" default="1"> + Maximum number of returned collisions, between [code]1[/code] and [code]32[/code]. Always returns the deepest detected collisions. + </member> + <member name="motion" type="Vector3" setter="set_motion" getter="get_motion" default="Vector3(0, 0, 0)"> + Motion vector to define the length and direction of the motion to test. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsTestMotionResult2D.xml b/doc/classes/PhysicsTestMotionResult2D.xml index 8d594af673..355365cf25 100644 --- a/doc/classes/PhysicsTestMotionResult2D.xml +++ b/doc/classes/PhysicsTestMotionResult2D.xml @@ -1,35 +1,91 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsTestMotionResult2D" inherits="RefCounted" version="4.0"> <brief_description> + Result from a 2D body motion test. </brief_description> <description> + This class contains the motion and collision result from [method PhysicsServer2D.body_test_motion]. </description> <tutorials> </tutorials> - <members> - <member name="collider" type="Object" setter="" getter="get_collider"> - </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> - </member> - <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> - </member> - <member name="collider_shape" type="int" setter="" getter="get_collider_shape" default="0"> - </member> - <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)"> - </member> - <member name="collision_depth" type="float" setter="" getter="get_collision_depth" default="0.0"> - </member> - <member name="collision_normal" type="Vector2" setter="" getter="get_collision_normal" default="Vector2(0, 0)"> - </member> - <member name="collision_point" type="Vector2" setter="" getter="get_collision_point" default="Vector2(0, 0)"> - </member> - <member name="collision_safe_fraction" type="float" setter="" getter="get_collision_safe_fraction" default="0.0"> - </member> - <member name="collision_unsafe_fraction" type="float" setter="" getter="get_collision_unsafe_fraction" default="0.0"> - </member> - <member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)"> - </member> - <member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)"> - </member> - </members> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's attached [Object], if a collision occured. + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the unique instance ID of the colliding body's attached [Object], if a collision occured. See [method Object.get_instance_id]. + </description> + </method> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID" /> + <description> + Returns the colliding body's [RID] used by the [PhysicsServer2D], if a collision occured. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int" /> + <description> + Returns the colliding body's shape index, if a collision occured. See [CollisionObject2D]. + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's velocity, if a collision occured. + </description> + </method> + <method name="get_collision_depth" qualifiers="const"> + <return type="float" /> + <description> + Returns the length of overlap along the collision normal, if a collision occured. + </description> + </method> + <method name="get_collision_local_shape" qualifiers="const"> + <return type="int" /> + <description> + Returns the moving object's colliding shape, if a collision occured. + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's shape's normal at the point of collision, if a collision occured. + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the point of collision in global coordinates, if a collision occured. + </description> + </method> + <method name="get_collision_safe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the maximum fraction of the motion that can occur without a collision, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_collision_unsafe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the minimum fraction of the motion needed to collide, if a collision occured, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's travel before collision. + </description> + </method> + </methods> </class> diff --git a/doc/classes/PhysicsTestMotionResult3D.xml b/doc/classes/PhysicsTestMotionResult3D.xml index 8aa087e99a..282c140568 100644 --- a/doc/classes/PhysicsTestMotionResult3D.xml +++ b/doc/classes/PhysicsTestMotionResult3D.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsTestMotionResult3D" inherits="RefCounted" version="4.0"> <brief_description> + Result from a 3D body motion test. </brief_description> <description> + This class contains the motion and collision result from [method PhysicsServer3D.body_test_motion]. </description> <tutorials> </tutorials> @@ -11,77 +13,94 @@ <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occured. See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occured. See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_count" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of detected collisions. </description> </method> <method name="get_collision_depth" qualifiers="const"> <return type="float" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_local_shape" qualifiers="const"> + <return type="int" /> + <argument index="0" name="collision_index" type="int" default="0" /> + <description> + Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_safe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the maximum fraction of the motion that can occur without a collision, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_collision_unsafe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the minimum fraction of the motion needed to collide, if a collision occured, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_best_collider"> - </member> - <member name="collider_id" type="int" setter="" getter="get_best_collider_id" default="0"> - </member> - <member name="collider_rid" type="RID" setter="" getter="get_best_collider_rid"> - </member> - <member name="collider_shape" type="int" setter="" getter="get_best_collider_shape" default="0"> - </member> - <member name="collider_velocity" type="Vector3" setter="" getter="get_best_collider_velocity" default="Vector3(0, 0, 0)"> - </member> - <member name="collision_count" type="int" setter="" getter="get_collision_count" default="0"> - </member> - <member name="collision_depth" type="float" setter="" getter="get_best_collision_depth" default="0.0"> - </member> - <member name="collision_normal" type="Vector3" setter="" getter="get_best_collision_normal" default="Vector3(0, 0, 0)"> - </member> - <member name="collision_point" type="Vector3" setter="" getter="get_best_collision_point" default="Vector3(0, 0, 0)"> - </member> - <member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3(0, 0, 0)"> - </member> - <member name="safe_fraction" type="float" setter="" getter="get_safe_fraction" default="0.0"> - </member> - <member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3(0, 0, 0)"> - </member> - <member name="unsafe_fraction" type="float" setter="" getter="get_unsafe_fraction" default="0.0"> - </member> - </members> </class> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index bc9b3cafb5..37a8e00b49 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -7,23 +7,23 @@ Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> </tutorials> - <methods> - <method name="Plane" qualifiers="constructor"> + <constructors> + <constructor name="Plane"> <return type="Plane" /> <description> Constructs a default-initialized [Plane] with all components set to [code]0[/code]. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="from" type="Plane" /> <description> Constructs a [Plane] as a copy of the given [Plane]. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="a" type="float" /> <argument index="1" name="b" type="float" /> @@ -32,24 +32,31 @@ <description> Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> + <return type="Plane" /> + <argument index="0" name="normal" type="Vector3" /> + <description> + Creates a plane from the normal vector. The plane will intersect the origin. + </description> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="normal" type="Vector3" /> <argument index="1" name="d" type="float" /> <description> - Creates a plane from the normal and the plane's distance to the origin. + Creates a plane from the normal vector and the plane's distance from the origin. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> - <argument index="0" name="point" type="Vector3" /> - <argument index="1" name="normal" type="Vector3" /> + <argument index="0" name="normal" type="Vector3" /> + <argument index="1" name="point" type="Vector3" /> <description> - Creates a plane from the given position and a plane normal. + Creates a plane from the normal vector and a point on the plane. </description> - </method> - <method name="Plane" qualifiers="constructor"> + </constructor> + <constructor name="Plane"> <return type="Plane" /> <argument index="0" name="point1" type="Vector3" /> <argument index="1" name="point2" type="Vector3" /> @@ -57,7 +64,9 @@ <description> Creates a plane from the three points, given in clockwise order. </description> - </method> + </constructor> + </constructors> + <methods> <method name="center" qualifiers="const"> <return type="Vector3" /> <description> @@ -123,38 +132,6 @@ Returns a copy of the plane, normalized. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Plane" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Plane" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Plane" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Plane" /> - <description> - </description> - </method> <method name="project" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="point" type="Vector3" /> @@ -193,4 +170,44 @@ A plane that extends in the X and Y axes (normal vector points +Z). </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Plane" /> + <description> + Returns [code]true[/code] if the planes are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Plane" /> + <description> + Returns [code]true[/code] if the planes are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator unary+"> + <return type="Plane" /> + <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. + </description> + </operator> + <operator name="operator unary-"> + <return type="Plane" /> + <description> + Returns the negative value of the [Plane]. This is the same as writing [code]Plane(-p.normal, -p.d)[/code]. This operation flips the direction of the normal vector and also flips the distance value, resulting in a Plane that is in the same place, but facing the opposite direction. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/PointLight2D.xml b/doc/classes/PointLight2D.xml index 9c13179056..ec809ed0a8 100644 --- a/doc/classes/PointLight2D.xml +++ b/doc/classes/PointLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. The units are in pixels, e.g. if the height is 100, then it will illuminate an object 100 pixels away at a 45° angle to the plane. </member> <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2(0, 0)"> The offset of the light's [member texture]. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 2208c12e56..4eb3ef34b4 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -15,7 +15,7 @@ <return type="void" /> <argument index="0" name="label" type="String" /> <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" default="0" /> + <argument index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -38,7 +38,7 @@ <argument index="0" name="texture" type="Texture2D" /> <argument index="1" name="label" type="String" /> <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" default="0" /> + <argument index="3" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -62,7 +62,7 @@ <argument index="0" name="texture" type="Texture2D" /> <argument index="1" name="label" type="String" /> <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" default="0" /> + <argument index="3" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -73,7 +73,7 @@ <argument index="0" name="texture" type="Texture2D" /> <argument index="1" name="label" type="String" /> <argument index="2" name="id" type="int" default="-1" /> - <argument index="3" name="accel" type="int" default="0" /> + <argument index="3" name="accel" type="int" enum="Key" default="0" /> <description> Same as [method add_icon_check_item], but uses a radio check button. </description> @@ -103,7 +103,7 @@ <return type="void" /> <argument index="0" name="label" type="String" /> <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" default="0" /> + <argument index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -115,7 +115,7 @@ <argument index="1" name="max_states" type="int" /> <argument index="2" name="default_state" type="int" default="0" /> <argument index="3" name="id" type="int" default="-1" /> - <argument index="4" name="accel" type="int" default="0" /> + <argument index="4" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new multistate item with text [code]label[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -126,7 +126,7 @@ <return type="void" /> <argument index="0" name="label" type="String" /> <argument index="1" name="id" type="int" default="-1" /> - <argument index="2" name="accel" type="int" default="0" /> + <argument index="2" name="accel" type="int" enum="Key" default="0" /> <description> Adds a new radio check button with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -193,18 +193,12 @@ </description> </method> <method name="get_item_accelerator" qualifiers="const"> - <return type="int" /> + <return type="int" enum="Key" /> <argument index="0" name="idx" type="int" /> <description> Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> - <method name="get_item_count" qualifiers="const"> - <return type="int" /> - <description> - Returns the number of items in the [PopupMenu]. - </description> - </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture2D" /> <argument index="0" name="idx" type="int" /> @@ -339,7 +333,7 @@ <method name="set_item_accelerator"> <return type="void" /> <argument index="0" name="idx" type="int" /> - <argument index="1" name="accel" type="int" /> + <argument index="1" name="accel" type="int" enum="Key" /> <description> Sets the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> @@ -511,6 +505,9 @@ <member name="hide_on_state_item_selection" type="bool" setter="set_hide_on_state_item_selection" getter="is_hide_on_state_item_selection" default="false"> If [code]true[/code], hides the [PopupMenu] when a state item is selected. </member> + <member name="items_count" type="int" setter="set_item_count" getter="get_item_count" default="0"> + The number of items currently in the list. + </member> <member name="submenu_popup_delay" type="float" setter="set_submenu_popup_delay" getter="get_submenu_popup_delay" default="0.3"> Sets the delay time in seconds for the submenu item to popup on mouse hovering. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item. </member> diff --git a/doc/classes/ProceduralSkyMaterial.xml b/doc/classes/ProceduralSkyMaterial.xml index 02e6a2d9f8..e3db74894b 100644 --- a/doc/classes/ProceduralSkyMaterial.xml +++ b/doc/classes/ProceduralSkyMaterial.xml @@ -5,7 +5,7 @@ </brief_description> <description> ProceduralSkyMaterial provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky. - The [ProceduralSkyMaterial] uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. + The [ProceduralSkyMaterial] uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. If you need a more realistic option, try using [PhysicalSkyMaterial] instead. The [ProceduralSkyMaterial] supports up to 4 suns. Each sun takes its color, energy, and direction from the corresponding [DirectionalLight3D] in the scene. </description> <tutorials> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index b3872121bf..7fdac7ccd4 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -6,8 +6,8 @@ <description> Contains global variables accessible from everywhere. Use [method get_setting], [method set_setting] or [method has_setting] to access them. Variables stored in [code]project.godot[/code] are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. When naming a Project Settings property, use the full path to the setting including the category. For example, [code]"application/config/name"[/code] for the project name. Category and property names can be viewed in the Project Settings dialog. - [b]Feature tags:[/b] Project settings can be overridden for specific platforms and configurations (debug, release, ...) using [url=https://docs.godotengine.org/en/latest/tutorials/export/feature_tags.html]feature tags[/url]. - [b]Overriding:[/b] Any project setting can be overridden by creating a file named [code]override.cfg[/code] in the project's root directory. This can also be used in exported projects by placing this file in the same directory as the project binary. Overriding will still take the base project settings' [url=https://docs.godotengine.org/en/latest/tutorials/export/feature_tags.html]feature tags[/url] in account. Therefore, make sure to [i]also[/i] override the setting with the desired feature tags if you want them to override base project settings on all platforms and configurations. + [b]Feature tags:[/b] Project settings can be overridden for specific platforms and configurations (debug, release, ...) using [url=$DOCS_URL/tutorials/export/feature_tags.html]feature tags[/url]. + [b]Overriding:[/b] Any project setting can be overridden by creating a file named [code]override.cfg[/code] in the project's root directory. This can also be used in exported projects by placing this file in the same directory as the project binary. Overriding will still take the base project settings' [url=$DOCS_URL/tutorials/export/feature_tags.html]feature tags[/url] in account. Therefore, make sure to [i]also[/i] override the setting with the desired feature tags if you want them to override base project settings on all platforms and configurations. </description> <tutorials> <link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link> @@ -87,7 +87,7 @@ <return type="String" /> <argument index="0" name="path" type="String" /> <description> - Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. + Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: [codeblock] var path = "" @@ -196,13 +196,17 @@ Background color for the boot splash. </member> <member name="application/boot_splash/fullsize" type="bool" setter="" getter="" default="true"> - If [code]true[/code], scale the boot splash image to the full window length when engine starts. If [code]false[/code], the engine will leave it at the default pixel size. + If [code]true[/code], scale the boot splash image to the full window size (preserving the aspect ratio) when the engine starts. If [code]false[/code], the engine will leave it at the default pixel size. </member> <member name="application/boot_splash/image" type="String" setter="" getter="" default=""""> - Path to an image used as the boot splash. + Path to an image used as the boot splash. If left empty, the default Godot Engine splash will be displayed instead. + [b]Note:[/b] Only effective if [member application/boot_splash/show_image] is [code]true[/code]. + </member> + <member name="application/boot_splash/show_image" type="bool" setter="" getter="" default="true"> + If [code]true[/code], displays the image specified in [member application/boot_splash/image] when the engine starts. If [code]false[/code], only displays the plain color specified in [member application/boot_splash/bg_color]. </member> <member name="application/boot_splash/use_filter" type="bool" setter="" getter="" default="true"> - If [code]true[/code], applies linear filtering when scaling the image (recommended for high resolution artwork). If [code]false[/code], uses nearest-neighbor interpolation (recommended for pixel art). + If [code]true[/code], applies linear filtering when scaling the image (recommended for high-resolution artwork). If [code]false[/code], uses nearest-neighbor interpolation (recommended for pixel art). </member> <member name="application/config/custom_user_dir_name" type="String" setter="" getter="" default=""""> This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). @@ -219,7 +223,7 @@ </member> <member name="application/config/name" type="String" setter="" getter="" default=""""> The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. The window title will be set to match the project name automatically on startup. - [b]Note:[/b] Changing this value will also change the user data folder's path if [member application/config/use_custom_user_dir] is [code]false[/code]. After renaming the project, you will no longer be able to access existing data in [code]user://[/code] unless you rename the old folder to match the new project name. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] in the documentation for more information. + [b]Note:[/b] Changing this value will also change the user data folder's path if [member application/config/use_custom_user_dir] is [code]false[/code]. After renaming the project, you will no longer be able to access existing data in [code]user://[/code] unless you rename the old folder to match the new project name. See [url=$DOCS_URL/tutorials/io/data_paths.html]Data paths[/url] in the documentation for more information. </member> <member name="application/config/project_settings_override" type="String" setter="" getter="" default=""""> Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code]. See "Overriding" in the [ProjectSettings] class description at the top for more information. @@ -228,6 +232,12 @@ <member name="application/config/use_custom_user_dir" type="bool" setter="" getter="" default="false"> If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code]. </member> + <member name="application/config/use_hidden_project_data_directory" type="bool" setter="" getter="" default="true"> + If [code]true[/code], the project will use a hidden directory ([code].godot[/code]) for storing project-specific data (metadata, shader cache, etc.). + If [code]false[/code], a non-hidden directory ([code]godot[/code]) will be used instead. + [b]Note:[/b] Restart the application after changing this setting. + [b]Note:[/b] Changing this value can help on platforms or with third-party tools where hidden directory patterns are disallowed. Only modify this setting if you know that your environment requires it, as changing the default can impact compatibility with some external tools or plugins which expect the default [code].godot[/code] folder. + </member> <member name="application/config/windows_native_icon" type="String" setter="" getter="" default=""""> Icon set in [code].ico[/code] format used on Windows to set the game's icon. This is done automatically on start by calling [method DisplayServer.set_native_icon]. </member> @@ -283,7 +293,9 @@ Safer override for [member audio/driver/mix_rate] in the Web platform. Here [code]0[/code] means "let the browser choose" (since some browsers do not like forcing the mix rate). </member> <member name="audio/driver/output_latency" type="int" setter="" getter="" default="15"> - Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. + Specifies the preferred output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware. + Audio output latency may be constrained by the host operating system and audio hardware drivers. If the host can not provide the specified audio output latency then Godot will attempt to use the nearest latency allowed by the host. As such you should always use [method AudioServer.get_output_latency] to determine the actual audio output latency. + [b]Note:[/b] This setting is ignored on all versions of Windows prior to Windows 10. </member> <member name="audio/driver/output_latency.web" type="int" setter="" getter="" default="50"> Safer override for [member audio/driver/output_latency] in the Web platform, to avoid audio issues especially on mobile devices. @@ -360,6 +372,9 @@ <member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum. </member> + <member name="debug/gdscript/warnings/shadowed_global_identifier" type="bool" setter="" getter="" default="true"> + If [code]true[/code], enables warnings when defining a local or subclass member variable, signal, or enum that would have the same name as a built-in function or global class name, which possibly shadow it. + </member> <member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable). </member> @@ -487,7 +502,7 @@ </member> <member name="display/window/size/fullscreen" type="bool" setter="" getter="" default="false"> Sets the main window to full screen when the project starts. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project. - Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. + Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. [b]Note:[/b] This setting is ignored on iOS, Android, and HTML5. </member> <member name="display/window/size/height" type="int" setter="" getter="" default="600"> @@ -1309,9 +1324,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]. @@ -1469,6 +1484,18 @@ The number of fixed iterations per second. This controls how often physics simulation and [method Node._physics_process] methods are run. [b]Note:[/b] This property is only read when the project starts. To change the physics FPS at runtime, set [member Engine.physics_ticks_per_second] instead. </member> + <member name="rendering/2d/opengl/batching_send_null" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/batching_stream" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/legacy_orphan_buffers" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/opengl/legacy_stream" type="int" setter="" getter="" default="0"> + </member> + <member name="rendering/2d/options/ninepatch_mode" type="int" setter="" getter="" default="1"> + </member> + <member name="rendering/2d/options/use_software_skinning" type="bool" setter="" getter="" default="true"> + </member> <member name="rendering/2d/sdf/oversize" type="int" setter="" getter="" default="1"> </member> <member name="rendering/2d/sdf/scale" type="int" setter="" getter="" default="1"> @@ -1479,11 +1506,8 @@ </member> <member name="rendering/2d/snap/snap_2d_vertices_to_pixel" type="bool" setter="" getter="" default="false"> </member> - <member name="rendering/3d/viewport/scale" type="int" setter="" getter="" default="0"> - Scale the 3D render buffer based on the viewport size. The smaller the faster 3D rendering is performed but at the cost of quality. - </member> <member name="rendering/anti_aliasing/quality/msaa" type="int" setter="" getter="" default="0"> - Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. + Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware. See also bilinear scaling 3d [member rendering/scaling_3d/mode] for supersampling, which provides higher quality but is much more expensive. </member> <member name="rendering/anti_aliasing/quality/screen_space_aa" type="int" setter="" getter="" default="0"> Sets the screen-space antialiasing mode for the default screen [Viewport]. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. @@ -1497,6 +1521,32 @@ </member> <member name="rendering/anti_aliasing/screen_space_roughness_limiter/limit" type="float" setter="" getter="" default="0.18"> </member> + <member name="rendering/batching/debug/diagnose_frame" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/debug/flash_batching" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/lights/max_join_items" type="int" setter="" getter="" default="32"> + </member> + <member name="rendering/batching/lights/scissor_area_threshold" type="float" setter="" getter="" default="1.0"> + </member> + <member name="rendering/batching/options/single_rect_fallback" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/options/use_batching" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/options/use_batching_in_editor" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/parameters/batch_buffer_size" type="int" setter="" getter="" default="16384"> + </member> + <member name="rendering/batching/parameters/colored_vertex_format_threshold" type="float" setter="" getter="" default="0.25"> + </member> + <member name="rendering/batching/parameters/item_reordering_lookahead" type="int" setter="" getter="" default="4"> + </member> + <member name="rendering/batching/parameters/max_join_item_commands" type="int" setter="" getter="" default="16"> + </member> + <member name="rendering/batching/precision/uv_contract" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/batching/precision/uv_contract_amount" type="int" setter="" getter="" default="100"> + </member> <member name="rendering/camera/depth_of_field/depth_of_field_bokeh_quality" type="int" setter="" getter="" default="1"> Sets the quality of the depth of field effect. Higher quality takes more samples, which is slower but looks smoother. </member> @@ -1512,8 +1562,9 @@ <member name="rendering/driver/depth_prepass/enable" type="bool" setter="" getter="" default="true"> If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used. </member> - <member name="rendering/driver/driver_name" type="String" setter="" getter="" default=""Vulkan""> - The video driver to use (currently only "Vulkan" is implemented). + <member name="rendering/driver/driver_name" type="String" setter="" getter="" default=""vulkan""> + The video driver to use. + [b]Note:[/b] OpenGL support is currently incomplete. Only basic 2D rendering is supported, and single-window mode is required for correct operation. [b]Note:[/b] The backend in use can be overridden at runtime via the [code]--rendering-driver[/code] command line argument. [b]FIXME:[/b] No longer valid after DisplayServer split: In such cases, this property is not updated, so use [code]OS.get_current_video_driver[/code] to query it at run-time. @@ -1570,10 +1621,17 @@ Scales the distance over which samples are taken for subsurface scattering effect. Changing this does not impact performance, but higher values will result in significant artifacts as the samples will become obviously spread out. A lower value results in a smaller spread of scattered light. </member> <member name="rendering/environment/volumetric_fog/use_filter" type="int" setter="" getter="" default="1"> + Enables filtering of the volumetric fog effect prior to integration. This substantially blurs the fog which reduces fine details but also smooths out harsh edges and aliasing artifacts. Disable when more detail is required. </member> - <member name="rendering/environment/volumetric_fog/volume_depth" type="int" setter="" getter="" default="128"> + <member name="rendering/environment/volumetric_fog/volume_depth" type="int" setter="" getter="" default="64"> + Number of slices to use along the depth of the froxel buffer for volumetric fog. A lower number will be more efficient but may result in artifacts appearing during camera movement. </member> <member name="rendering/environment/volumetric_fog/volume_size" type="int" setter="" getter="" default="64"> + Base size used to determine size of froxel buffer in the camera X-axis and Y-axis. The final size is scaled by the aspect ratio of the screen, so actual values may differ from what is set. Set a larger size for more detailed fog, set a smaller size for better performance. + </member> + <member name="rendering/gles2/compatibility/disable_half_float" type="bool" setter="" getter="" default="false"> + </member> + <member name="rendering/gles2/compatibility/enable_high_float.Android" type="bool" setter="" getter="" default="false"> </member> <member name="rendering/global_illumination/gi/use_half_resolution" type="bool" setter="" getter="" default="false"> </member> @@ -1656,6 +1714,18 @@ <member name="rendering/reflections/sky_reflections/texture_array_reflections.mobile" type="bool" setter="" getter="" default="false"> Lower-end override for [member rendering/reflections/sky_reflections/texture_array_reflections] on mobile devices, due to performance concerns or driver support. </member> + <member name="rendering/scaling_3d/fsr_mipmap_bias" type="float" setter="" getter="" default="0.0"> + Affects the final texture sharpness by reading from a lower or higher mipmap. Negative values make textures sharper, while positive values make textures blurrier. When using FSR, this value is used to adjust the mipmap bias calculated internally which is based on the selected quality. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code] + </member> + <member name="rendering/scaling_3d/fsr_sharpness" type="float" setter="" getter="" default="0.2"> + Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. + </member> + <member name="rendering/scaling_3d/mode" type="int" setter="" getter="" default="0"> + Sets the scaling 3D mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. + </member> + <member name="rendering/scaling_3d/scale" type="float" setter="" getter="" default="1.0"> + Scales the 3D render buffer based on the viewport size uses an image filter specified in [member rendering/scaling_3d/mode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [member rendering/anti_aliasing/quality/msaa] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + </member> <member name="rendering/shader_compiler/shader_cache/compress" type="bool" setter="" getter="" default="true"> </member> <member name="rendering/shader_compiler/shader_cache/enabled" type="bool" setter="" getter="" default="true"> @@ -1692,8 +1762,10 @@ <member name="rendering/shadows/directional_shadow/size.mobile" type="int" setter="" getter="" default="2048"> Lower-end override for [member rendering/shadows/directional_shadow/size] on mobile devices, due to performance concerns or driver support. </member> - <member name="rendering/shadows/directional_shadow/soft_shadow_quality" type="int" setter="" getter="" default="2"> + <member name="rendering/shadows/directional_shadow/soft_shadow_quality" type="int" setter="" getter="" default="3"> Quality setting for shadows cast by [DirectionalLight3D]s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. + [b]Note:[/b] The Soft Very Low setting will automatically multiply [i]constant[/i] shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in [member Light3D.shadow_blur], not the variable blur performed by [DirectionalLight3D]s' [member Light3D.light_angular_distance]. + [b]Note:[/b] The Soft High and Soft Ultra settings will automatically multiply [i]constant[/i] shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. </member> <member name="rendering/shadows/directional_shadow/soft_shadow_quality.mobile" type="int" setter="" getter="" default="0"> Lower-end override for [member rendering/shadows/directional_shadow/soft_shadow_quality] on mobile devices, due to performance concerns or driver support. @@ -1718,8 +1790,10 @@ <member name="rendering/shadows/shadow_atlas/size.mobile" type="int" setter="" getter="" default="2048"> Lower-end override for [member rendering/shadows/shadow_atlas/size] on mobile devices, due to performance concerns or driver support. </member> - <member name="rendering/shadows/shadows/soft_shadow_quality" type="int" setter="" getter="" default="2"> + <member name="rendering/shadows/shadows/soft_shadow_quality" type="int" setter="" getter="" default="3"> Quality setting for shadows cast by [OmniLight3D]s and [SpotLight3D]s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. + [b]Note:[/b] The Soft Very Low setting will automatically multiply [i]constant[/i] shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in [member Light3D.shadow_blur], not the variable blur performed by [DirectionalLight3D]s' [member Light3D.light_angular_distance]. + [b]Note:[/b] The Soft High and Soft Ultra settings will automatically multiply shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. </member> <member name="rendering/shadows/shadows/soft_shadow_quality.mobile" type="int" setter="" getter="" default="0"> Lower-end override for [member rendering/shadows/shadows/soft_shadow_quality] on mobile devices, due to performance concerns or driver support. @@ -1744,23 +1818,23 @@ </member> <member name="rendering/textures/vram_compression/import_bptc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer. - [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor. + [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). </member> <member name="rendering/textures/vram_compression/import_etc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures. - [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor. + [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). </member> <member name="rendering/textures/vram_compression/import_etc2" type="bool" setter="" getter="" default="true"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the Vulkan renderer. - [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor. + [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). </member> <member name="rendering/textures/vram_compression/import_pvrtc" type="bool" setter="" getter="" default="false"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS. - [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor. + [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). </member> <member name="rendering/textures/vram_compression/import_s3tc" type="bool" setter="" getter="" default="true"> If [code]true[/code], the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles. - [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor. + [b]Note:[/b] Changing this setting does [i]not[/i] impact textures that were already imported before. To make this setting apply to textures that were already imported, exit the editor, remove the [code].godot/imported/[/code] folder located inside the project folder then restart the editor (see [member application/config/use_hidden_project_data_directory]). </member> <member name="rendering/vulkan/descriptor_pools/max_descriptors_per_pool" type="int" setter="" getter="" default="64"> </member> diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 7858ac732b..9fa2d9b60b 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -9,53 +9,52 @@ Due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating-point errors. </description> <tutorials> - <link title="Using 3D transforms">https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> + <link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.html#interpolating-with-quaternions</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> - <methods> - <method name="Quaternion" qualifiers="constructor"> + <constructors> + <constructor name="Quaternion"> <return type="Quaternion" /> <description> Constructs a default-initialized quaternion with all components set to [code]0[/code]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="from" type="Quaternion" /> <description> Constructs a [Quaternion] as a copy of the given [Quaternion]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="arc_from" type="Vector3" /> <argument index="1" name="arc_to" type="Vector3" /> <description> </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="axis" type="Vector3" /> <argument index="1" name="angle" type="float" /> <description> Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="euler" type="Vector3" /> + <argument index="0" name="euler_yxz" type="Vector3" /> <description> - Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="from" type="Basis" /> <description> Constructs a quaternion from the given [Basis]. </description> - </method> - <method name="Quaternion" qualifiers="constructor"> + </constructor> + <constructor name="Quaternion"> <return type="Quaternion" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -64,7 +63,9 @@ <description> Constructs a quaternion defined by the given values. </description> - </method> + </constructor> + </constructors> + <methods> <method name="angle_to" qualifiers="const"> <return type="float" /> <argument index="0" name="to" type="Quaternion" /> @@ -90,6 +91,16 @@ Returns the dot product of two quaternions. </description> </method> + <method name="get_angle" qualifiers="const"> + <return type="float" /> + <description> + </description> + </method> + <method name="get_axis" qualifiers="const"> + <return type="Vector3" /> + <description> + </description> + </method> <method name="get_euler" qualifiers="const"> <return type="Vector3" /> <description> @@ -133,131 +144,148 @@ Returns a copy of the quaternion, normalized to unit length. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="slerp" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="to" type="Quaternion" /> + <argument index="1" name="weight" type="float" /> <description> + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. + [b]Note:[/b] Both quaternions must be normalized. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <method name="slerpni" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="to" type="Quaternion" /> + <argument index="1" name="weight" type="float" /> <description> + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. </description> </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + </methods> + <members> + <member name="w" type="float" setter="" getter="" default="1.0"> + W component of the quaternion (real part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="x" type="float" setter="" getter="" default="0.0"> + X component of the quaternion (imaginary [code]i[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="y" type="float" setter="" getter="" default="0.0"> + Y component of the quaternion (imaginary [code]j[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + <member name="z" type="float" setter="" getter="" default="0.0"> + Z component of the quaternion (imaginary [code]k[/code] axis part). + Quaternion components should usually not be manipulated directly. + </member> + </members> + <constants> + <constant name="IDENTITY" value="Quaternion(0, 0, 0, 1)"> + The identity quaternion, representing no rotation. Equivalent to an identity [Basis] matrix. If a vector is transformed by an identity quaternion, it will not change. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> <description> </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + Returns [code]true[/code] if the quaternions are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> + Composes these two quaternions by multiplying them together. This has the effect of rotating the second quaternion (the child) by the first quaternion (the parent). </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Rotates (multiplies) the [Vector3] by the given [Quaternion]. + </description> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="float" /> <description> + Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Quaternion" /> <argument index="0" name="right" type="int" /> <description> + Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> + Adds each component of the left [Quaternion] to the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Quaternion" /> <argument index="0" name="right" type="Quaternion" /> <description> + Subtracts each component of the left [Quaternion] by the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Quaternion" /> <argument index="0" name="right" type="float" /> <description> + Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Quaternion" /> <argument index="0" name="right" type="int" /> <description> + Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Quaternion" /> <description> + Returns [code]true[/code] if the quaternions are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="float" /> <argument index="0" name="index" type="int" /> <description> + Access quaternion components using their index. [code]q[0][/code] is equivalent to [code]q.x[/code], [code]q[1][/code] is equivalent to [code]q.y[/code], [code]q[2][/code] is equivalent to [code]q.z[/code], and [code]q[3][/code] is equivalent to [code]q.w[/code]. </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Quaternion" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="Quaternion" /> <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="slerp" qualifiers="const"> - <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> - <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. - [b]Note:[/b] Both quaternions must be normalized. - </description> - </method> - <method name="slerpni" qualifiers="const"> + </operator> + <operator name="operator unary-"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. + Returns the negative value of the [Quaternion]. This is the same as writing [code]Quaternion(-q.x, -q.y, -q.z, -q.w)[/code]. This operation results in a quaternion that represents the same rotation. </description> - </method> - </methods> - <members> - <member name="w" type="float" setter="" getter="" default="1.0"> - W component of the quaternion (real part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="x" type="float" setter="" getter="" default="0.0"> - X component of the quaternion (imaginary [code]i[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="y" type="float" setter="" getter="" default="0.0"> - Y component of the quaternion (imaginary [code]j[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - <member name="z" type="float" setter="" getter="" default="0.0"> - Z component of the quaternion (imaginary [code]k[/code] axis part). - Quaternion components should usually not be manipulated directly. - </member> - </members> - <constants> - <constant name="IDENTITY" value="Quaternion(0, 0, 0, 1)"> - The identity quaternion, representing no rotation. Equivalent to an identity [Basis] matrix. If a vector is transformed by an identity quaternion, it will not change. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index b4ba74f7e5..695b0933fa 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -8,71 +8,75 @@ </description> <tutorials> </tutorials> - <methods> - <method name="RID" qualifiers="constructor"> + <constructors> + <constructor name="RID"> <return type="RID" /> <description> Constructs an empty [RID] with the invalid ID [code]0[/code]. </description> - </method> - <method name="RID" qualifiers="constructor"> + </constructor> + <constructor name="RID"> <return type="RID" /> <argument index="0" name="from" type="RID" /> <description> Constructs a [RID] as a copy of the given [RID]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="get_id" qualifiers="const"> <return type="int" /> <description> Returns the ID of the referenced resource. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="RID" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index c011755df1..53d1554272 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -16,7 +16,7 @@ [b]Note:[/b] The default values of [member seed] and [member state] properties are pseudo-random, and changes when calling [method randomize]. The [code]0[/code] value documented here is a placeholder, and not the actual default seed. </description> <tutorials> - <link title="Random number generation">https://docs.godotengine.org/en/latest/tutorials/math/random_number_generation.html</link> + <link title="Random number generation">$DOCS_URL/tutorials/math/random_number_generation.html</link> </tutorials> <methods> <method name="randf"> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index ce5d48cfa4..fe2885378a 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -11,7 +11,7 @@ RayCast2D calculates intersection every physics frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast. </description> <tutorials> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <methods> <method name="add_exception"> @@ -63,14 +63,14 @@ <method name="get_collision_normal" qualifiers="const"> <return type="Vector2" /> <description> - Returns the normal of the intersecting object's shape at the collision point. + Returns the normal of the intersecting object's shape at the collision point, or [code]Vector2(0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code]. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector2" /> <description> Returns the collision point at which the ray intersects the closest object. - [b]Note:[/b] this point is in the [b]global[/b] coordinate system. + [b]Note:[/b] This point is in the [b]global[/b] coordinate system. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -110,7 +110,7 @@ If [code]true[/code], collision with [PhysicsBody2D]s will be reported. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be 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. + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true"> If [code]true[/code], collisions will be reported. @@ -118,6 +118,9 @@ <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true"> If [code]true[/code], the parent node will be excluded from collision detection. </member> + <member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false"> + If [code]true[/code], the ray will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector2(0, 0)[/code]. Does not affect concave polygon shapes. + </member> <member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2(0, 50)"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index c7253e81c4..8abd3f84b1 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -11,7 +11,7 @@ RayCast3D calculates intersection every physics frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame), use [method force_raycast_update] after adjusting the raycast. </description> <tutorials> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <methods> @@ -65,7 +65,7 @@ <method name="get_collision_normal" qualifiers="const"> <return type="Vector3" /> <description> - Returns the normal of the intersecting object's shape at the collision point. + Returns the normal of the intersecting object's shape at the collision point, or [code]Vector3(0, 0, 0)[/code] if the ray starts inside the shape and [member hit_from_inside] is [code]true[/code]. </description> </method> <method name="get_collision_point" qualifiers="const"> @@ -112,7 +112,7 @@ If [code]true[/code], collision with [PhysicsBody3D]s will be reported. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be 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. + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="debug_shape_custom_color" type="Color" setter="set_debug_shape_custom_color" getter="get_debug_shape_custom_color" default="Color(0, 0, 0, 1)"> The custom color to use to draw the shape in the editor and at run-time if [b]Visible Collision Shapes[/b] is enabled in the [b]Debug[/b] menu. This color will be highlighted at run-time if the [RayCast3D] is colliding with something. @@ -127,6 +127,9 @@ <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true"> If [code]true[/code], collisions will be ignored for this RayCast3D's immediate parent. </member> + <member name="hit_from_inside" type="bool" setter="set_hit_from_inside" getter="is_hit_from_inside_enabled" default="false"> + If [code]true[/code], the ray will detect a hit when starting inside shapes. In this case the collision normal will be [code]Vector3(0, 0, 0)[/code]. Does not affect shapes with no volume like concave polygon or heightmap. + </member> <member name="target_position" type="Vector3" setter="set_target_position" getter="get_target_position" default="Vector3(0, -1, 0)"> The ray's destination point, relative to the RayCast's [code]position[/code]. </member> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index e585224818..65d1654c21 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -7,42 +7,43 @@ [Rect2] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses floating-point coordinates. If you need integer coordinates, use [Rect2i] instead. The 3D counterpart to [Rect2] is [AABB]. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get a Rect2 with a positive size. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> - <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> + <link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link> </tutorials> - <methods> - <method name="Rect2" qualifiers="constructor"> + <constructors> + <constructor name="Rect2"> <return type="Rect2" /> <description> Constructs a default-initialized [Rect2] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="from" type="Rect2" /> <description> Constructs a [Rect2] as a copy of the given [Rect2]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2] from a [Rect2i]. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="position" type="Vector2" /> <argument index="1" name="size" type="Vector2" /> <description> Constructs a [Rect2] by position and size. </description> - </method> - <method name="Rect2" qualifiers="constructor"> + </constructor> + <constructor name="Rect2"> <return type="Rect2" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -51,7 +52,9 @@ <description> Constructs a [Rect2] by x, y, width, and height. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Rect2" /> <description> @@ -69,7 +72,22 @@ <return type="Rect2" /> <argument index="0" name="to" type="Vector2" /> <description> - Returns this [Rect2] expanded to include a given point. + Returns a copy of this [Rect2] expanded to include a given point. + [b]Example:[/b] + [codeblocks] + [gdscript] + # position (-3, 2), size (1, 1) + var rect = Rect2(Vector2(-3, 2), Vector2(1, 1)) + # position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) + var rect2 = rect.expand(Vector2(0, -1)) + [/gdscript] + [csharp] + # position (-3, 2), size (1, 1) + var rect = new Rect2(new Vector2(-3, 2), new Vector2(1, 1)); + # position (-3, -1), size (3, 4), so we fit both rect and Vector2(0, -1) + var rect2 = rect.Expand(new Vector2(0, -1)); + [/csharp] + [/codeblocks] </description> </method> <method name="get_area" qualifiers="const"> @@ -119,7 +137,8 @@ <return type="bool" /> <argument index="0" name="point" type="Vector2" /> <description> - Returns [code]true[/code] if the [Rect2] contains a point. + Returns [code]true[/code] if the [Rect2] contains a point. By convention, the right and bottom edges of the [Rect2] are considered exclusive, so points on these edges are [b]not[/b] included. + [b]Note:[/b] This method is not reliable for [Rect2] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. </description> </method> <method name="intersection" qualifiers="const"> @@ -153,45 +172,52 @@ Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Rect2" /> <description> + Returns [code]true[/code] if the rectangles are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Rect2" /> <argument index="0" name="right" type="Transform2D" /> <description> + Inversely transforms (multiplies) the [Rect2] by the given [Transform2D] transformation matrix. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Rect2" /> <description> + Returns [code]true[/code] if the rectangles are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> - </method> - </methods> - <members> - <member name="end" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector2" setter="" getter="" default="Vector2(0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 2f6f4de66d..5909784135 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -6,41 +6,42 @@ <description> [Rect2i] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. It uses integer coordinates. If you need floating-point coordinates, use [Rect2] instead. + Negative values for [member size] are not supported and will not work for most methods. Use [method abs] to get a Rect2i with a positive size. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> </tutorials> - <methods> - <method name="Rect2i" qualifiers="constructor"> + <constructors> + <constructor name="Rect2i"> <return type="Rect2i" /> <description> Constructs a default-initialized [Rect2i] with default (zero) values of [member position] and [member size]. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="from" type="Rect2i" /> <description> Constructs a [Rect2i] as a copy of the given [Rect2i]. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="from" type="Rect2" /> <description> Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="position" type="Vector2i" /> <argument index="1" name="size" type="Vector2i" /> <description> Constructs a [Rect2i] by position and size. </description> - </method> - <method name="Rect2i" qualifiers="constructor"> + </constructor> + <constructor name="Rect2i"> <return type="Rect2i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> @@ -49,7 +50,9 @@ <description> Constructs a [Rect2i] by x, y, width, and height. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Rect2i" /> <description> @@ -67,7 +70,21 @@ <return type="Rect2i" /> <argument index="0" name="to" type="Vector2i" /> <description> - Returns this [Rect2i] expanded to include a given point. + Returns a copy of this [Rect2i] expanded to include a given point. + [codeblocks] + [gdscript] + # position (-3, 2), size (1, 1) + var rect = Rect2i(Vector2i(-3, 2), Vector2i(1, 1)) + # position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1) + var rect2 = rect.expand(Vector2i(0, -1)) + [/gdscript] + [csharp] + # position (-3, 2), size (1, 1) + var rect = new Rect2i(new Vector2i(-3, 2), new Vector2i(1, 1)); + # position (-3, -1), size (3, 4), so we fit both rect and Vector2i(0, -1) + var rect2 = rect.Expand(new Vector2i(0, -1)); + [/csharp] + [/codeblocks] </description> </method> <method name="get_area" qualifiers="const"> @@ -118,7 +135,8 @@ <return type="bool" /> <argument index="0" name="point" type="Vector2i" /> <description> - Returns [code]true[/code] if the [Rect2i] contains a point. + Returns [code]true[/code] if the [Rect2i] contains a point. By convention, the right and bottom edges of the [Rect2i] are considered exclusive, so points on these edges are [b]not[/b] included. + [b]Note:[/b] This method is not reliable for [Rect2i] with a [i]negative size[/i]. Use [method abs] to get a positive sized equivalent rectangle to check for contained points. </description> </method> <method name="intersection" qualifiers="const"> @@ -144,39 +162,43 @@ Returns a larger [Rect2i] that contains this [Rect2i] and [code]b[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. + </member> + <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Beginning corner. Typically has values lower than [member end]. + </member> + <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> + Size from [member position] to [member end]. Typically, all components are positive. + If the size is negative, you can use [method abs] to fix it. + </member> + </members> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Rect2i" /> <description> + Returns [code]true[/code] if the rectangles are not equal. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Rect2i" /> <description> + Returns [code]true[/code] if the rectangles are equal. </description> - </method> - </methods> - <members> - <member name="end" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Ending corner. This is calculated as [code]position + size[/code]. Setting this value will change the size. - </member> - <member name="position" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Beginning corner. Typically has values lower than [member end]. - </member> - <member name="size" type="Vector2i" setter="" getter="" default="Vector2i(0, 0)"> - Size from [member position] to [member end]. Typically, all components are positive. - If the size is negative, you can use [method abs] to fix it. - </member> - </members> + </operator> + </operators> </class> diff --git a/doc/classes/RefCounted.xml b/doc/classes/RefCounted.xml index 5f18ccc14d..378df6f155 100644 --- a/doc/classes/RefCounted.xml +++ b/doc/classes/RefCounted.xml @@ -5,12 +5,12 @@ </brief_description> <description> Base class for any object that keeps a reference count. [Resource] and many other helper objects inherit this class. - Unlike other [Object] types, References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with [method Object.free]. + Unlike other [Object] types, [RefCounted]s keep an internal reference counter so that they are automatically released when no longer in use, and only then. [RefCounted]s therefore do not need to be freed manually with [method Object.free]. In the vast majority of use cases, instantiating and using [RefCounted]-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. - [b]Note:[/b] In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed. + [b]Note:[/b] In C#, reference-counted objects will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free reference-counted objects that are no longer in use. This means that unused ones will linger on for a while before being removed. </description> <tutorials> - <link title="When and how to avoid using nodes for everything">https://docs.godotengine.org/en/latest/getting_started/workflow/best_practices/node_alternatives.html</link> + <link title="When and how to avoid using nodes for everything">$DOCS_URL/tutorials/best_practices/node_alternatives.html</link> </tutorials> <methods> <method name="init_ref"> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index 1db6879b45..99ad067469 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -16,7 +16,7 @@ Sets the border width of the [ReferenceRect]. The border grows both inwards and outwards with respect to the rectangle box. </member> <member name="editor_only" type="bool" setter="set_editor_only" getter="get_editor_only" default="true"> - If set to [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in game. + If [code]true[/code], the [ReferenceRect] will only be visible while in editor. Otherwise, [ReferenceRect] will be visible in the running project. </member> </members> </class> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index 7f2bd118d6..8bf8534334 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -8,7 +8,7 @@ The [ReflectionProbe] is used to create high-quality reflections at the cost of performance. It can be combined with [VoxelGI]s and Screen Space Reflections to achieve high quality reflections. [ReflectionProbe]s render all objects within their [member cull_mask], so updating them can be quite expensive. It is best to update them once with the important static objects and then leave them. </description> <tutorials> - <link title="Reflection probes">https://docs.godotengine.org/en/latest/tutorials/3d/reflection_probes.html</link> + <link title="Reflection probes">$DOCS_URL/tutorials/3d/reflection_probes.html</link> </tutorials> <members> <member name="ambient_color" type="Color" setter="set_ambient_color" getter="get_ambient_color" default="Color(0, 0, 0, 1)"> diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 428fa2575c..442dcc7d18 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -374,7 +374,7 @@ </method> <method name="get_memory_usage" qualifiers="const"> <return type="int" /> - <argument index="0" name="arg0" type="int" enum="RenderingDevice.MemoryType" /> + <argument index="0" name="type" type="int" enum="RenderingDevice.MemoryType" /> <description> </description> </method> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index b5be04fb01..0700650a91 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -15,7 +15,7 @@ In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas. </description> <tutorials> - <link title="Optimization using Servers">https://docs.godotengine.org/en/latest/tutorials/optimization/using_servers.html</link> + <link title="Optimization using Servers">$DOCS_URL/tutorials/performance/using_servers.html</link> </tutorials> <methods> <method name="bake_render_uv2"> @@ -185,6 +185,18 @@ <description> </description> </method> + <method name="canvas_item_add_msdf_texture_rect_region"> + <return type="void" /> + <argument index="0" name="item" type="RID" /> + <argument index="1" name="rect" type="Rect2" /> + <argument index="2" name="texture" type="RID" /> + <argument index="3" name="src_rect" type="Rect2" /> + <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <argument index="5" name="outline_size" type="int" default="0" /> + <argument index="6" name="px_range" type="float" default="1.0" /> + <description> + </description> + </method> <method name="canvas_item_add_multimesh"> <return type="void" /> <argument index="0" name="item" type="RID" /> @@ -920,7 +932,6 @@ <argument index="3" name="energy" type="float" default="1.0" /> <argument index="4" name="sky_contibution" type="float" default="0.0" /> <argument index="5" name="reflection_source" type="int" enum="RenderingServer.EnvironmentReflectionSource" default="0" /> - <argument index="6" name="ao_color" type="Color" default="Color(0, 0, 0, 1)" /> <description> </description> </method> @@ -1109,13 +1120,16 @@ <argument index="0" name="env" type="RID" /> <argument index="1" name="enable" type="bool" /> <argument index="2" name="density" type="float" /> - <argument index="3" name="light" type="Color" /> - <argument index="4" name="light_energy" type="float" /> - <argument index="5" name="length" type="float" /> - <argument index="6" name="p_detail_spread" type="float" /> - <argument index="7" name="gi_inject" type="float" /> - <argument index="8" name="temporal_reprojection" type="bool" /> - <argument index="9" name="temporal_reprojection_amount" type="float" /> + <argument index="3" name="albedo" type="Color" /> + <argument index="4" name="emission" type="Color" /> + <argument index="5" name="emission_energy" type="float" /> + <argument index="6" name="anisotropy" type="float" /> + <argument index="7" name="length" type="float" /> + <argument index="8" name="p_detail_spread" type="float" /> + <argument index="9" name="gi_inject" type="float" /> + <argument index="10" name="temporal_reprojection" type="bool" /> + <argument index="11" name="temporal_reprojection_amount" type="float" /> + <argument index="12" name="ambient_inject" type="float" /> <description> </description> </method> @@ -1123,6 +1137,7 @@ <return type="void" /> <argument index="0" name="active" type="bool" /> <description> + Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts. </description> </method> <method name="environment_set_volumetric_fog_volume_size"> @@ -1130,6 +1145,37 @@ <argument index="0" name="size" type="int" /> <argument index="1" name="depth" type="int" /> <description> + Sets the resolution of the volumetric fog's froxel buffer. [code]size[/code] is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While [code]depth[/code] is directly used to set the depth of the buffer. + </description> + </method> + <method name="fog_volume_create"> + <return type="RID" /> + <description> + Creates a new fog volume and allocates an RID. + </description> + </method> + <method name="fog_volume_set_extents"> + <return type="void" /> + <argument index="0" name="fog_volume" type="RID" /> + <argument index="1" name="extents" type="Vector3" /> + <description> + Sets the size of the fog volume when shape is [constant FOG_VOLUME_SHAPE_ELLIPSOID] or [constant FOG_VOLUME_SHAPE_BOX]. + </description> + </method> + <method name="fog_volume_set_material"> + <return type="void" /> + <argument index="0" name="fog_volume" type="RID" /> + <argument index="1" name="material" type="RID" /> + <description> + Sets the [Material] of the fog volume. Can be either a [FogMaterial] or a custom [ShaderMaterial]. + </description> + </method> + <method name="fog_volume_set_shape"> + <return type="void" /> + <argument index="0" name="fog_volume" type="RID" /> + <argument index="1" name="shape" type="int" enum="RenderingServer.FogVolumeShape" /> + <description> + Sets the shape of the fog volume to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX], or [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD]. </description> </method> <method name="force_draw"> @@ -1366,6 +1412,14 @@ <description> </description> </method> + <method name="instance_geometry_set_transparency"> + <return type="void" /> + <argument index="0" name="instance" type="RID" /> + <argument index="1" name="transparency" type="float" /> + <description> + Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency]. + </description> + </method> <method name="instance_geometry_set_visibility_range"> <return type="void" /> <argument index="0" name="instance" type="RID" /> @@ -1373,6 +1427,7 @@ <argument index="2" name="max" type="float" /> <argument index="3" name="min_margin" type="float" /> <argument index="4" name="max_margin" type="float" /> + <argument index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" /> <description> Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties. </description> @@ -1410,6 +1465,13 @@ Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to [member GeometryInstance3D.extra_cull_margin]. </description> </method> + <method name="instance_set_ignore_culling"> + <return type="void" /> + <argument index="0" name="instance" type="RID" /> + <argument index="1" name="enabled" type="bool" /> + <description> + </description> + </method> <method name="instance_set_layer_mask"> <return type="void" /> <argument index="0" name="instance" type="RID" /> @@ -2339,7 +2401,8 @@ <argument index="0" name="particles" type="RID" /> <argument index="1" name="material" type="RID" /> <description> - Sets the material for processing the particles. Note: this is not the material used to draw the materials. Equivalent to [member GPUParticles3D.process_material]. + Sets the material for processing the particles. + [b]Note:[/b] This is not the material used to draw the materials. Equivalent to [member GPUParticles3D.process_material]. </description> </method> <method name="particles_set_randomness_ratio"> @@ -2512,12 +2575,9 @@ </method> <method name="request_frame_drawn_callback"> <return type="void" /> - <argument index="0" name="where" type="Object" /> - <argument index="1" name="method" type="StringName" /> - <argument index="2" name="userdata" type="Variant" /> + <argument index="0" name="callable" type="Callable" /> <description> - Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn. - The callback method must use only 1 argument which will be called with [code]userdata[/code]. + Schedules a callback to the given callable after a frame has been drawn. </description> </method> <method name="scenario_create"> @@ -2601,8 +2661,10 @@ <return type="RID" /> <argument index="0" name="shader" type="RID" /> <argument index="1" name="param" type="StringName" /> + <argument index="2" name="index" type="int" default="0" /> <description> Returns a default texture from a shader searched by name. + [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. </description> </method> <method name="shader_get_param_default" qualifiers="const"> @@ -2624,8 +2686,10 @@ <argument index="0" name="shader" type="RID" /> <argument index="1" name="param" type="StringName" /> <argument index="2" name="texture" type="RID" /> + <argument index="3" name="index" type="int" default="0" /> <description> Sets a shader's default texture. Overwrites the texture given by name. + [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. </description> </method> <method name="shadows_quality_set"> @@ -3036,6 +3100,22 @@ If [code]true[/code], rendering of a viewport's environment is disabled. </description> </method> + <method name="viewport_set_fsr_mipmap_bias"> + <return type="void" /> + <argument index="0" name="viewport" type="RID" /> + <argument index="1" name="mipmap_bias" type="float" /> + <description> + Affects the final texture sharpness by reading from a lower or higher mipmap. Negative values make textures sharper, while positive values make textures blurrier. When using FSR, this value is used to adjust the mipmap bias calculated internally which is based on the selected quality. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code] + </description> + </method> + <method name="viewport_set_fsr_sharpness"> + <return type="void" /> + <argument index="0" name="viewport" type="RID" /> + <argument index="1" name="sharpness" type="float" /> + <description> + Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. + </description> + </method> <method name="viewport_set_global_canvas_transform"> <return type="void" /> <argument index="0" name="viewport" type="RID" /> @@ -3087,12 +3167,21 @@ If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. </description> </method> - <method name="viewport_set_scale_3d"> + <method name="viewport_set_scaling_3d_mode"> <return type="void" /> <argument index="0" name="viewport" type="RID" /> - <argument index="1" name="scale" type="int" enum="RenderingServer.ViewportScale3D" /> + <argument index="1" name="scaling_3d_mode" type="int" enum="RenderingServer.ViewportScaling3DMode" /> + <description> + Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. + </description> + </method> + <method name="viewport_set_scaling_3d_scale"> + <return type="void" /> + <argument index="0" name="viewport" type="RID" /> + <argument index="1" name="scale" type="float" /> <description> - Sets the scale at which we render 3D contents. + Scales the 3D render buffer based on the viewport size uses an image filter specified in [enum ViewportScaling3DMode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [enum ViewportMSAA] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale. </description> </method> <method name="viewport_set_scenario"> @@ -3396,7 +3485,10 @@ <constant name="SHADER_SKY" value="3" enum="ShaderMode"> Shader is a sky shader. </constant> - <constant name="SHADER_MAX" value="4" enum="ShaderMode"> + <constant name="SHADER_FOG" value="4" enum="ShaderMode"> + Shader is a fog shader. + </constant> + <constant name="SHADER_MAX" value="5" enum="ShaderMode"> Represents the size of the [enum ShaderMode] enum. </constant> <constant name="MATERIAL_RENDER_PRIORITY_MIN" value="-128"> @@ -3651,16 +3743,25 @@ Use 4 splits for shadow projection when using directional light. </constant> <constant name="SHADOW_QUALITY_HARD" value="0" enum="ShadowQuality"> + Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the [member Light3D.shadow_blur] property is ignored if [member Light3D.light_size] and [member Light3D.light_angular_distance] is [code]0.0[/code]. + [b]Note:[/b] The variable shadow blur performed by [member Light3D.light_size] and [member Light3D.light_angular_distance] is still effective when using hard shadow filtering. In this case, [member Light3D.shadow_blur] [i]is[/i] taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra. + </constant> + <constant name="SHADOW_QUALITY_SOFT_VERY_LOW" value="1" enum="ShadowQuality"> + Very low shadow filtering quality (faster). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]). </constant> - <constant name="SHADOW_QUALITY_SOFT_LOW" value="1" enum="ShadowQuality"> + <constant name="SHADOW_QUALITY_SOFT_LOW" value="2" enum="ShadowQuality"> + Low shadow filtering quality (fast). </constant> - <constant name="SHADOW_QUALITY_SOFT_MEDIUM" value="2" enum="ShadowQuality"> + <constant name="SHADOW_QUALITY_SOFT_MEDIUM" value="3" enum="ShadowQuality"> + Medium low shadow filtering quality (average). </constant> - <constant name="SHADOW_QUALITY_SOFT_HIGH" value="3" enum="ShadowQuality"> + <constant name="SHADOW_QUALITY_SOFT_HIGH" value="4" enum="ShadowQuality"> + High low shadow filtering quality (slow). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]). </constant> - <constant name="SHADOW_QUALITY_SOFT_ULTRA" value="4" enum="ShadowQuality"> + <constant name="SHADOW_QUALITY_SOFT_ULTRA" value="5" enum="ShadowQuality"> + Highest low shadow filtering quality (slowest). When using this quality setting, [member Light3D.shadow_blur] is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose [member Light3D.light_size] or [member Light3D.light_angular_distance] is [code]0.0[/code]). </constant> - <constant name="SHADOW_QUALITY_MAX" value="5" enum="ShadowQuality"> + <constant name="SHADOW_QUALITY_MAX" value="6" enum="ShadowQuality"> </constant> <constant name="REFLECTION_PROBE_UPDATE_ONCE" value="0" enum="ReflectionProbeUpdateMode"> Reflection probe will update reflections once and then stop. @@ -3759,6 +3860,23 @@ </constant> <constant name="PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX" value="6" enum="ParticlesCollisionHeightfieldResolution"> </constant> + <constant name="FOG_VOLUME_SHAPE_ELLIPSOID" value="0" enum="FogVolumeShape"> + [FogVolume] will be shaped like an ellipsoid. + </constant> + <constant name="FOG_VOLUME_SHAPE_BOX" value="1" enum="FogVolumeShape"> + [FogVolume] will be shaped like a box. + </constant> + <constant name="FOG_VOLUME_SHAPE_WORLD" value="2" enum="FogVolumeShape"> + [FogVolume] will have no shape, will cover the whole world and will not be culled. + </constant> + <constant name="VIEWPORT_SCALING_3D_MODE_BILINEAR" value="0" enum="ViewportScaling3DMode"> + Enables bilinear scaling on 3D viewports. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less then [code]1.0[/code] will result in undersampling while values greater than [code]1.0[/code] will result in supersampling. A value of [code]1.0[/code] disables scaling. + </constant> + <constant name="VIEWPORT_SCALING_3D_MODE_FSR" value="1" enum="ViewportScaling3DMode"> + Enables FSR upscaling on 3D viewports. The amount of scaling can be set using [member Viewport.scaling_3d_scale]. Values less then [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear supersampling will be used instead. A value of [code]1.0[/code] disables scaling. + </constant> + <constant name="VIEWPORT_SCALING_3D_MODE_MAX" value="2" enum="ViewportScaling3DMode"> + </constant> <constant name="VIEWPORT_UPDATE_DISABLED" value="0" enum="ViewportUpdateMode"> Do not update the viewport. </constant> @@ -3906,16 +4024,6 @@ </constant> <constant name="VIEWPORT_DEBUG_DRAW_OCCLUDERS" value="23" enum="ViewportDebugDraw"> </constant> - <constant name="VIEWPORT_SCALE_3D_DISABLED" value="0" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_75_PERCENT" value="1" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_50_PERCENT" value="2" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_33_PERCENT" value="3" enum="ViewportScale3D"> - </constant> - <constant name="VIEWPORT_SCALE_3D_25_PERCENT" value="4" enum="ViewportScale3D"> - </constant> <constant name="SKY_MODE_AUTOMATIC" value="0" enum="SkyMode"> </constant> <constant name="SKY_MODE_QUALITY" value="1" enum="SkyMode"> @@ -4135,7 +4243,9 @@ </constant> <constant name="INSTANCE_VISIBLITY_NOTIFIER" value="11" enum="InstanceType"> </constant> - <constant name="INSTANCE_MAX" value="12" enum="InstanceType"> + <constant name="INSTANCE_FOG_VOLUME" value="12" enum="InstanceType"> + </constant> + <constant name="INSTANCE_MAX" value="13" enum="InstanceType"> Represents the size of the [enum InstanceType] enum. </constant> <constant name="INSTANCE_GEOMETRY_MASK" value="14" enum="InstanceType"> @@ -4167,6 +4277,15 @@ <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting"> Only render the shadows from the object. The object itself will not be drawn. </constant> + <constant name="VISIBILITY_RANGE_FADE_DISABLED" value="0" enum="VisibilityRangeFadeMode"> + Disable visibility range fading for the given instance. + </constant> + <constant name="VISIBILITY_RANGE_FADE_SELF" value="1" enum="VisibilityRangeFadeMode"> + Fade-out the given instance when it approaches its visibility range limits. + </constant> + <constant name="VISIBILITY_RANGE_FADE_DEPENDENCIES" value="2" enum="VisibilityRangeFadeMode"> + Fade-in the given instance's dependencies when reaching its visibility range limits. + </constant> <constant name="BAKE_CHANNEL_ALBEDO_ALPHA" value="0" enum="BakeChannels"> </constant> <constant name="BAKE_CHANNEL_NORMAL" value="1" enum="BakeChannels"> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 45b68f342c..02d1c7e97d 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -8,8 +8,8 @@ [b]Note:[/b] In C#, resources will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free resources that are no longer in use. This means that unused resources will linger on for a while before being removed. </description> <tutorials> - <link title="Resources">https://docs.godotengine.org/en/latest/getting_started/step_by_step/resources.html</link> - <link title="When and how to avoid using nodes for everything">https://docs.godotengine.org/en/latest/getting_started/workflow/best_practices/node_alternatives.html</link> + <link title="Resources">$DOCS_URL/tutorials/scripting/resources.html</link> + <link title="When and how to avoid using nodes for everything">$DOCS_URL/tutorials/best_practices/node_alternatives.html</link> </tutorials> <methods> <method name="duplicate" qualifiers="const"> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml index 9f551ad1d2..f20b55fbc8 100644 --- a/doc/classes/ResourceImporter.xml +++ b/doc/classes/ResourceImporter.xml @@ -7,7 +7,7 @@ This is the base class for the resource importers implemented in core. To implement your own resource importers using editor plugins, see [EditorImportPlugin]. </description> <tutorials> - <link title="Import plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/import_plugins.html</link> + <link title="Import plugins">$DOCS_URL/tutorials/plugins/editor/import_plugins.html</link> </tutorials> <constants> <constant name="IMPORT_ORDER_DEFAULT" value="0" enum="ImportOrder"> diff --git a/doc/classes/RichTextEffect.xml b/doc/classes/RichTextEffect.xml index cf4b4f4a48..4329ccfdf5 100644 --- a/doc/classes/RichTextEffect.xml +++ b/doc/classes/RichTextEffect.xml @@ -19,7 +19,7 @@ [b]Note:[/b] As soon as a [RichTextLabel] contains at least one [RichTextEffect], it will continuously process the effect unless the project is paused. This may impact battery life negatively. </description> <tutorials> - <link title="BBCode in RichTextLabel">https://docs.godotengine.org/en/latest/tutorials/gui/bbcode_in_richtextlabel.html</link> + <link title="BBCode in RichTextLabel">$DOCS_URL/tutorials/ui/bbcode_in_richtextlabel.html</link> <link title="RichTextEffect test project (third-party)">https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project</link> </tutorials> <methods> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 50db1dc122..6bfaca8928 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -11,7 +11,7 @@ [b]Note:[/b] Unlike [Label], RichTextLabel doesn't have a [i]property[/i] to horizontally align text to the center. Instead, enable [member bbcode_enabled] and surround the text in a [code][center][/code] tag as follows: [code][center]Example[/center][/code]. There is currently no built-in way to vertically align text either, but this can be emulated by relying on anchors/containers and the [member fit_content_height] property. </description> <tutorials> - <link title="BBCode in RichTextLabel">https://docs.godotengine.org/en/latest/tutorials/gui/bbcode_in_richtextlabel.html</link> + <link title="BBCode in RichTextLabel">$DOCS_URL/tutorials/ui/bbcode_in_richtextlabel.html</link> <link title="GUI Rich Text/BBcode Demo">https://godotengine.org/asset-library/asset/132</link> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> @@ -36,10 +36,10 @@ </description> </method> <method name="append_text"> - <return type="int" enum="Error" /> + <return type="void" /> <argument index="0" name="bbcode" type="String" /> <description> - Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful. + Parses [code]bbcode[/code] and adds tags to the tag stack as needed. [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_text] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member text] instead of using [method append_text]. </description> </method> @@ -101,6 +101,7 @@ <return type="VScrollBar" /> <description> Returns the vertical scrollbar. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_visible_line_count" qualifiers="const"> @@ -129,10 +130,10 @@ </description> </method> <method name="parse_bbcode"> - <return type="int" enum="Error" /> + <return type="void" /> <argument index="0" name="bbcode" type="String" /> <description> - The assignment version of [method append_text]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully. + The assignment version of [method append_text]. Clears the tag stack and inserts the new content. </description> </method> <method name="parse_expressions_for_values"> @@ -378,6 +379,9 @@ The currently installed custom effects. This is an array of [RichTextEffect]s. To add a custom effect, it's more convenient to use [method install_effect]. </member> + <member name="deselect_on_focus_loss_enabled" type="bool" setter="set_deselect_on_focus_loss_enabled" getter="is_deselect_on_focus_loss_enabled" default="true"> + If [code]true[/code], the selected text will be deselected when focus is lost. + </member> <member name="fit_content_height" type="bool" setter="set_fit_content_height" getter="is_fit_content_height_enabled" default="false"> If [code]true[/code], the label's height will be automatically updated to fit its content. [b]Note:[/b] This property is used as a workaround to fix issues with [RichTextLabel] in [Container]s, but it's unreliable in some cases and will be removed in future versions. @@ -582,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/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml index 9baed392eb..b8680b99b3 100644 --- a/doc/classes/RigidDynamicBody2D.xml +++ b/doc/classes/RigidDynamicBody2D.xml @@ -82,10 +82,13 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps the body's [member angular_velocity]. If [code]-1[/code], the body will use the [b]Default Angular Damp[/b] defined in [b]Project > Project Settings > Physics > 2d[/b]. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b] or any value override set by an [Area2D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="RigidDynamicBody2D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity" default="0.0"> The body's rotational velocity. </member> @@ -135,10 +138,13 @@ The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. If set to [code]0[/code], inertia is automatically computed (default value). </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b] or any value override set by an [Area2D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="RigidDynamicBody2D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector2(0, 0)"> The body's linear velocity. </member> @@ -174,27 +180,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody2D's [Shape2D]s collides with another [PhysicsBody2D] or [TileMap]'s [Shape2D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody2D's [Shape2D]s and another [PhysicsBody2D] or [TileMap]'s [Shape2D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="sleeping_state_changed"> @@ -217,6 +223,12 @@ <constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode"> In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position. </constant> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> <constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode"> Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml index 7d1c7fecfa..c75055e0df 100644 --- a/doc/classes/RigidDynamicBody3D.xml +++ b/doc/classes/RigidDynamicBody3D.xml @@ -10,7 +10,7 @@ If you need to override the default physics behavior, you can write a custom force integration function. See [member custom_integrator]. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> <link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/524</link> <link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link> </tutorials> @@ -91,10 +91,13 @@ </method> </methods> <members> - <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="-1.0"> - Damps RigidDynamicBody3D's rotational forces. + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.0"> + Damps the body's rotation. By default, the body will use the [b]Default Angular Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member angular_damp_mode], you can set [member angular_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. </member> + <member name="angular_damp_mode" type="int" setter="set_angular_damp_mode" getter="get_angular_damp_mode" enum="RigidDynamicBody3D.DampMode" default="0"> + Defines how [member angular_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)"> RigidDynamicBody3D's rotational velocity. </member> @@ -138,10 +141,13 @@ The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body on each axis. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value. If set to [code]Vector3.ZERO[/code], inertia is automatically computed (default value). </member> - <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> - The body's linear damp. Cannot be less than -1.0. If this value is different from -1.0, any linear damp derived from the world or areas will be overridden. + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.0"> + Damps the body's movement. By default, the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 3d[/b] or any value override set by an [Area3D] the body is in. Depending on [member linear_damp_mode], you can set [member linear_damp] to be added to or to replace the body's damping value. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. </member> + <member name="linear_damp_mode" type="int" setter="set_linear_damp_mode" getter="get_linear_damp_mode" enum="RigidDynamicBody3D.DampMode" default="0"> + Defines how [member linear_damp] is applied. See [enum DampMode] for possible values. + </member> <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)"> The body's linear velocity. Can be used sporadically, but [b]don't set this every frame[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. </member> @@ -177,28 +183,28 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody3D's [Shape3D]s collides with another [PhysicsBody3D] or [GridMap]'s [Shape3D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody3D's [Shape3D]s and another [PhysicsBody3D] or [GridMap]'s [Shape3D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. + [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices. </description> </signal> @@ -222,5 +228,11 @@ <constant name="CENTER_OF_MASS_MODE_CUSTOM" value="1" enum="CenterOfMassMode"> In this mode, the body's center of mass is set through [member center_of_mass]. Defaults to the body's origin position. </constant> + <constant name="DAMP_MODE_COMBINE" value="0" enum="DampMode"> + In this mode, the body's damping value is added to any value set in areas or the default value. + </constant> + <constant name="DAMP_MODE_REPLACE" value="1" enum="DampMode"> + In this mode, the body's damping value replaces any value set in areas or the default value. + </constant> </constants> </class> diff --git a/doc/classes/RootMotionView.xml b/doc/classes/RootMotionView.xml index 5db13de44f..203a48996f 100644 --- a/doc/classes/RootMotionView.xml +++ b/doc/classes/RootMotionView.xml @@ -8,7 +8,7 @@ [b]Note:[/b] [RootMotionView] is only visible in the editor. It will be hidden automatically in the running project, and will also be converted to a plain [Node] in the running project. This means a script attached to a [RootMotionView] node [i]must[/i] have [code]extends Node[/code] instead of [code]extends RootMotionView[/code]. Additionally, it must not be a [code]@tool[/code] script. </description> <tutorials> - <link title="Using AnimationTree - Root motion">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#root-motion</link> + <link title="Using AnimationTree - Root motion">$DOCS_URL/tutorials/animation/animation_tree.html#root-motion</link> </tutorials> <members> <member name="animation_path" type="NodePath" setter="set_animation_path" getter="get_animation_path"> 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/SceneTree.xml b/doc/classes/SceneTree.xml index 8d7427611a..c1dca44896 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -9,8 +9,8 @@ [SceneTree] is the default [MainLoop] implementation used by scenes, and is thus in charge of the game loop. </description> <tutorials> - <link title="SceneTree">https://docs.godotengine.org/en/latest/getting_started/step_by_step/scene_tree.html</link> - <link title="Multiple resolutions">https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html</link> + <link title="SceneTree">$DOCS_URL/tutorials/scripting/scene_tree.html</link> + <link title="Multiple resolutions">$DOCS_URL/tutorials/rendering/multiple_resolutions.html</link> </tutorials> <methods> <method name="call_group" qualifiers="vararg"> @@ -19,6 +19,7 @@ <argument index="1" name="method" type="StringName" /> <description> Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. This method is equivalent of calling [method call_group_flags] with [constant GROUP_CALL_DEFAULT] flag. + [b]Note:[/b] Due to design limitations, [method call_group] will fail silently if one of the arguments is [code]null[/code]. [b]Note:[/b] [method call_group] will always call methods with an one-frame delay, in a way similar to [method Object.call_deferred]. To call methods immediately, use [method call_group_flags] with the [constant GROUP_CALL_REALTIME] flag. </description> </method> @@ -29,8 +30,10 @@ <argument index="2" name="method" type="StringName" /> <description> Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. + [b]Note:[/b] Due to design limitations, [method call_group_flags] will fail silently if one of the arguments is [code]null[/code]. [codeblock] - get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") # Call the method immediately and in reverse order. + # Call the method immediately and in reverse order. + get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") [/codeblock] </description> </method> @@ -63,7 +66,7 @@ [gdscript] func some_function(): print("start") - yield(get_tree().create_timer(1.0), "timeout") + await get_tree().create_timer(1.0).timeout print("end") [/gdscript] [csharp] diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index f97c5e42b5..b0509a322e 100644 --- a/doc/classes/SceneTreeTimer.xml +++ b/doc/classes/SceneTreeTimer.xml @@ -10,7 +10,7 @@ [gdscript] func some_function(): print("Timer started.") - yield(get_tree().create_timer(1.0), "timeout") + await get_tree().create_timer(1.0).timeout print("Timer ended.") [/gdscript] [csharp] diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index b7a4f448b0..ab88bdaa73 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -8,7 +8,7 @@ The [code]new[/code] method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. </description> <tutorials> - <link title="Scripting">https://docs.godotengine.org/en/latest/getting_started/step_by_step/scripting.html</link> + <link title="Scripting documentation index">$DOCS_URL/tutorials/scripting/index.html</link> </tutorials> <methods> <method name="can_instantiate" qualifiers="const"> diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index 1e72fe9090..88adeaf12f 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -9,6 +9,13 @@ <tutorials> </tutorials> <methods> + <method name="add_syntax_highlighter"> + <return type="void" /> + <argument index="0" name="highlighter" type="EditorSyntaxHighlighter" /> + <description> + Adds a [EditorSyntaxHighlighter] to the open script. + </description> + </method> <method name="get_base_editor" qualifiers="const"> <return type="Control" /> <description> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 1cf8c6cb54..976c32c243 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -22,12 +22,14 @@ <return type="HScrollBar" /> <description> Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use [member scroll_horizontal_enabled]. If you want to only hide it instead, use [member scroll_horizontal_visible]. </description> </method> <method name="get_v_scrollbar"> <return type="VScrollBar" /> <description> Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use [member scroll_vertical_enabled]. If you want to only hide it instead, use [member scroll_vertical_visible]. </description> </method> </methods> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 2f3fa021d4..9e1d8012b7 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -7,7 +7,7 @@ A synchronization semaphore which can be used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex]. </description> <tutorials> - <link title="Using multiple threads">https://docs.godotengine.org/en/latest/tutorials/threads/using_multiple_threads.html</link> + <link title="Using multiple threads">$DOCS_URL/tutorials/performance/using_multiple_threads.html</link> </tutorials> <methods> <method name="post"> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index bc5457b8ce..d81b4bc372 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -7,16 +7,17 @@ This class allows you to define a custom shader program that can be used by a [ShaderMaterial]. Shaders allow you to write your own custom behavior for rendering objects or updating particle information. For a detailed explanation and usage, please see the tutorials linked below. </description> <tutorials> - <link title="Shading tutorial index">https://docs.godotengine.org/en/latest/tutorials/shading/index.html</link> - <link title="What are shaders?">https://docs.godotengine.org/en/latest/tutorials/shading/your_first_shader/what_are_shaders.html</link> + <link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link> </tutorials> <methods> <method name="get_default_texture_param" qualifiers="const"> <return type="Texture2D" /> <argument index="0" name="param" type="StringName" /> + <argument index="1" name="index" type="int" default="0" /> <description> Returns the texture that is set as default for the specified parameter. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. + [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. </description> </method> <method name="get_mode" qualifiers="const"> @@ -37,9 +38,11 @@ <return type="void" /> <argument index="0" name="param" type="StringName" /> <argument index="1" name="texture" type="Texture2D" /> + <argument index="2" name="index" type="int" default="0" /> <description> Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial]. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. + [b]Note:[/b] If the sampler array is used use [code]index[/code] to access the specified texture. </description> </method> </methods> @@ -61,5 +64,8 @@ <constant name="MODE_SKY" value="3" enum="Mode"> Mode used for drawing skies. Only works with shaders attached to [Sky] objects. </constant> + <constant name="MODE_FOG" value="4" enum="Mode"> + Mode used for setting the color and density of volumetric fog effect. + </constant> </constants> </class> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 13f2e2fe5f..04f0fac104 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -7,7 +7,7 @@ A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader. </description> <tutorials> - <link title="Shading tutorial index">https://docs.godotengine.org/en/latest/tutorials/shading/index.html</link> + <link title="Shaders documentation index">$DOCS_URL/tutorials/shaders/index.html</link> </tutorials> <methods> <method name="get_shader_param" qualifiers="const"> @@ -36,7 +36,8 @@ <argument index="0" name="param" type="StringName" /> <argument index="1" name="value" type="Variant" /> <description> - Changes the value set for this material of a uniform in the shader. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. + Changes the value set for this material of a uniform in the shader. + [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. </description> </method> </methods> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 04f91d19da..9746519173 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -7,7 +7,7 @@ Base class for all 2D shapes. All 2D shape types inherit from this. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> </tutorials> <methods> <method name="collide"> diff --git a/doc/classes/Shape3D.xml b/doc/classes/Shape3D.xml index 96f8833486..67af52768f 100644 --- a/doc/classes/Shape3D.xml +++ b/doc/classes/Shape3D.xml @@ -7,7 +7,7 @@ Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a [PhysicsBody3D] or [Area3D] objects. </description> <tutorials> - <link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link> + <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link> </tutorials> <methods> <method name="get_debug_mesh"> diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml new file mode 100644 index 0000000000..74ebafe069 --- /dev/null +++ b/doc/classes/ShapeCast2D.xml @@ -0,0 +1,157 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ShapeCast2D" inherits="Node2D" version="4.0"> + <brief_description> + Node for physics collision sweep and immediate overlap queries. Similar to the [RayCast2D] node. + </brief_description> + <description> + Shape casting allows to detect collision objects by sweeping the [member shape] along the cast direction determined by [member target_position] (useful for things like beam weapons). + Immediate collision overlaps can be done with the [member target_position] set to [code]Vector2(0, 0)[/code] and by calling [method force_shapecast_update] within the same [b]physics_frame[/b]. This also helps to overcome some limitations of [Area2D] when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to [Area2D] nodes, and when using the signals creates unnecessary complexity. + The node can detect multiple collision objects, but usually the first detected collision + [b]Note:[/b] shape casting is more computationally expensive compared to ray casting. + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_exception"> + <return type="void" /> + <argument index="0" name="node" type="Object" /> + <description> + Adds a collision exception so the shape does not report collisions with the specified node. + </description> + </method> + <method name="add_exception_rid"> + <return type="void" /> + <argument index="0" name="rid" type="RID" /> + <description> + Adds a collision exception so the shape does not report collisions with the specified [RID]. + </description> + </method> + <method name="clear_exceptions"> + <return type="void" /> + <description> + Removes all collision exceptions for this shape. + </description> + </method> + <method name="force_shapecast_update"> + <return type="void" /> + <description> + Updates the collision information for the shape. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the shape or its parent has changed state. + [b]Note:[/b] [code]enabled == true[/code] is not required for this to work. + </description> + </method> + <method name="get_closest_collision_safe_fraction" qualifiers="const"> + <return type="float" /> + <description> + The fraction of the motion (between 0 and 1) of how far the shape can move without triggering a collision. The motion is determined by [member target_position]. + </description> + </method> + <method name="get_closest_collision_unsafe_fraction" qualifiers="const"> + <return type="float" /> + <description> + The fraction of the motion (between 0 and 1) when the shape triggers a collision. The motion is determined by [member target_position]. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <argument index="0" name="index" type="int" /> + <description> + Returns the [Object] of one of the multiple collisions at [code]index[/code], or [code]null[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int" /> + <argument index="0" name="index" type="int" /> + <description> + Returns the shape ID of one of the multiple collisions at [code]index[/code] that the shape intersects, or [code]0[/code] if no object is intersecting the shape (i.e. [method is_colliding] returns [code]false[/code]). + </description> + </method> + <method name="get_collision_count" qualifiers="const"> + <return type="int" /> + <description> + The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by [method get_collider], [method get_collider_shape], [method get_collision_point], and [method get_collision_normal] methods. + </description> + </method> + <method name="get_collision_mask_value" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="layer_number" type="int" /> + <description> + Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + Returns the normal containing one of the multiple collisions at [code]index[/code] of the intersecting object. + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + Returns the collision point containing one of the multiple collisions at [code]index[/code] at which the shape intersects the object. + [b]Note:[/b] this point is in the [b]global[/b] coordinate system. + </description> + </method> + <method name="is_colliding" qualifiers="const"> + <return type="bool" /> + <description> + Returns whether any object is intersecting with the shape's vector (considering the vector length). + </description> + </method> + <method name="remove_exception"> + <return type="void" /> + <argument index="0" name="node" type="Object" /> + <description> + Removes a collision exception so the shape does report collisions with the specified node. + </description> + </method> + <method name="remove_exception_rid"> + <return type="void" /> + <argument index="0" name="rid" type="RID" /> + <description> + Removes a collision exception so the shape does report collisions with the specified [RID]. + </description> + </method> + <method name="set_collision_mask_value"> + <return type="void" /> + <argument index="0" name="layer_number" type="int" /> + <argument index="1" name="value" type="bool" /> + <description> + Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. + </description> + </method> + </methods> + <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], collision with [Area2D]s will be reported. + </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], collision with [PhysicsBody2D]s will be reported. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> + The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. + </member> + <member name="collision_result" type="Array" setter="" getter="_get_collision_result" default="[]"> + A complete collision information. The data returned is the same as in the [method PhysicsDirectSpaceState2D.get_rest_info] method. + </member> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true"> + If [code]true[/code], collisions will be reported. + </member> + <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body" default="true"> + If [code]true[/code], the parent node will be excluded from collision detection. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> + The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision. + </member> + <member name="max_results" type="int" setter="set_max_results" getter="get_max_results" default="32"> + The number of intersections can be limited with this parameter, to reduce the processing time. + </member> + <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape"> + Any [Shape2D] derived shape used for collision queries. + </member> + <member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2(0, 50)"> + The shape's destination point, relative to this node's [code]position[/code]. + </member> + </members> +</class> diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 9fbe91f38b..f95d069069 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -4,8 +4,8 @@ A shortcut for binding input. </brief_description> <description> - A shortcut for binding input. Shortcuts are commonly used for interacting with a [Control] element from an [InputEvent] (also known as hotkeys). + One shortcut can contain multiple [InputEvent]'s, allowing the possibility of triggering one action with multiple different inputs. </description> <tutorials> </tutorials> @@ -13,27 +13,27 @@ <method name="get_as_text" qualifiers="const"> <return type="String" /> <description> - Returns the shortcut's [InputEvent] as a [String]. + Returns the shortcut's first valid [InputEvent] as a [String]. </description> </method> <method name="has_valid_event" qualifiers="const"> <return type="bool" /> <description> - Returns whether the shortcut has a valid [member event] assigned to it. + Returns whether [member events] contains an [InputEvent] which is valid. </description> </method> <method name="matches_event" qualifiers="const"> <return type="bool" /> <argument index="0" name="event" type="InputEvent" /> <description> - Returns whether the shortcut's [member event] matches [code]event[/code]. + Returns whether any [InputEvent] in [member events] equals [code]event[/code]. </description> </method> </methods> <members> - <member name="event" type="InputEvent" setter="set_event" getter="get_event"> - The shortcut's [InputEvent]. - Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction]. + <member name="events" type="Array" setter="set_events" getter="get_events" default="[]"> + The shortcut's [InputEvent] array. + Generally the [InputEvent] used is an [InputEventKey], though it can be any [InputEvent], including an [InputEventAction]. </member> </members> </class> diff --git a/doc/classes/Signal.xml b/doc/classes/Signal.xml index f78266a20c..79d6ba8768 100644 --- a/doc/classes/Signal.xml +++ b/doc/classes/Signal.xml @@ -7,28 +7,30 @@ </description> <tutorials> </tutorials> - <methods> - <method name="Signal" qualifiers="constructor"> + <constructors> + <constructor name="Signal"> <return type="Signal" /> <description> Constructs a null [Signal] with no object nor signal name bound. </description> - </method> - <method name="Signal" qualifiers="constructor"> + </constructor> + <constructor name="Signal"> <return type="Signal" /> <argument index="0" name="from" type="Signal" /> <description> Constructs a [Signal] as a copy of the given [Signal]. </description> - </method> - <method name="Signal" qualifiers="constructor"> + </constructor> + <constructor name="Signal"> <return type="Signal" /> <argument index="0" name="object" type="Object" /> <argument index="1" name="signal" type="StringName" /> <description> Creates a new [Signal] with the name [code]signal[/code] in the specified [code]object[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="connect"> <return type="int" /> <argument index="0" name="callable" type="Callable" /> @@ -93,27 +95,29 @@ <description> </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Signal" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Signal" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index 7aa06985bf..20bec14795 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -8,7 +8,7 @@ To setup different types of inverse kinematics for the given Skeleton2D, a [SkeletonModificationStack2D] should be created. They can be applied by creating the desired number of modifications, which can be done by increasing [member SkeletonModificationStack2D.modification_count]. </description> <tutorials> - <link title="2D skeletons">https://docs.godotengine.org/en/latest/tutorials/animation/2d_skeletons.html</link> + <link title="2D skeletons">$DOCS_URL/tutorials/animation/2d_skeletons.html</link> </tutorials> <methods> <method name="execute_modifications"> diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index c2b514f232..e804e7bf24 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -47,6 +47,11 @@ Removes the local pose override on all bones in the skeleton. </description> </method> + <method name="create_skin_from_rest_transforms"> + <return type="Skin" /> + <description> + </description> + </method> <method name="execute_modifications"> <return type="void" /> <argument index="0" name="delta" type="float" /> @@ -88,13 +93,6 @@ Returns the amount of bones in the skeleton. </description> </method> - <method name="get_bone_custom_pose" qualifiers="const"> - <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> - <description> - Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - </description> - </method> <method name="get_bone_global_pose" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="bone_idx" type="int" /> @@ -144,6 +142,24 @@ Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> + <method name="get_bone_pose_position" qualifiers="const"> + <return type="Vector3" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> + <method name="get_bone_pose_rotation" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> + <method name="get_bone_pose_scale" qualifiers="const"> + <return type="Vector3" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> <method name="get_bone_rest" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="bone_idx" type="int" /> @@ -189,11 +205,11 @@ This is helper function to make using [method Transform3D.looking_at] easier with bone poses. </description> </method> - <method name="is_bone_rest_disabled" qualifiers="const"> + <method name="is_bone_enabled" qualifiers="const"> <return type="bool" /> <argument index="0" name="bone_idx" type="int" /> <description> - Returns whether the bone rest for the bone at [code]bone_idx[/code] is disabled. + Returns whether the bone pose for the bone at [code]bone_idx[/code] is enabled. </description> </method> <method name="local_pose_to_global_pose"> @@ -265,21 +281,12 @@ Sets the children for the passed in bone, [code]bone_idx[/code], to the passed-in array of bone indexes, [code]bone_children[/code]. </description> </method> - <method name="set_bone_custom_pose"> - <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="custom_pose" type="Transform3D" /> - <description> - Sets the custom pose transform, [code]custom_pose[/code], for the bone at [code]bone_idx[/code]. This pose is an addition to the bone rest pose. - [b]Note:[/b] The pose transform needs to be in bone space. Use [method world_transform_to_global_pose] to convert a world transform, like one you can get from a [Node3D], to bone space. - </description> - </method> - <method name="set_bone_disable_rest"> + <method name="set_bone_enabled"> <return type="void" /> <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="disable" type="bool" /> + <argument index="1" name="enabled" type="bool" default="true" /> <description> - Disables the rest pose for the bone at [code]bone_idx[/code] if [code]true[/code], enables the bone rest if [code]false[/code]. + Disables the pose for the bone at [code]bone_idx[/code] if [code]false[/code], enables the bone pose if [code]true[/code]. </description> </method> <method name="set_bone_global_pose_override"> @@ -322,13 +329,25 @@ [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. </description> </method> - <method name="set_bone_pose"> + <method name="set_bone_pose_position"> <return type="void" /> <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> + <argument index="1" name="position" type="Vector3" /> + <description> + </description> + </method> + <method name="set_bone_pose_rotation"> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> + <argument index="1" name="rotation" type="Quaternion" /> + <description> + </description> + </method> + <method name="set_bone_pose_scale"> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> + <argument index="1" name="scale" type="Vector3" /> <description> - Sets the pose transform for bone [code]bone_idx[/code]. - [b]Note:[/b] The pose transform needs to be in bone space. Use [method world_transform_to_global_pose] to convert a world transform, like one you can get from a [Node3D], to bone space. </description> </method> <method name="set_bone_rest"> @@ -365,8 +384,15 @@ <members> <member name="animate_physical_bones" type="bool" setter="set_animate_physical_bones" getter="get_animate_physical_bones" default="true"> </member> + <member name="show_rest_only" type="bool" setter="set_show_rest_only" getter="is_show_rest_only" default="false"> + </member> </members> <signals> + <signal name="bone_enabled_changed"> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </signal> <signal name="bone_pose_changed"> <argument index="0" name="bone_idx" type="int" /> <description> @@ -377,6 +403,10 @@ <description> </description> </signal> + <signal name="show_rest_only_changed"> + <description> + </description> + </signal> </signals> <constants> <constant name="NOTIFICATION_UPDATE_SKELETON" value="50"> diff --git a/doc/classes/SkeletonModification2DCCDIK.xml b/doc/classes/SkeletonModification2DCCDIK.xml index ab9a482609..6cbc24f100 100644 --- a/doc/classes/SkeletonModification2DCCDIK.xml +++ b/doc/classes/SkeletonModification2DCCDIK.xml @@ -4,7 +4,7 @@ A modification that uses CCDIK to manipulate a series of bones to reach a target in 2D. </brief_description> <description> - This [SkeletonModification2D] uses an algorithm called [b]C[/b]yclic [b]C[/b]oordinate [b]D[/b]escent [b]I[/b]nverse [b]K[/b]inematics, or CCDIK, to manipulate a chain of bones in a [Skeleton2D] so it reaches a defined target. + This [SkeletonModification2D] uses an algorithm called Cyclic Coordinate Descent Inverse Kinematics, or CCDIK, to manipulate a chain of bones in a [Skeleton2D] so it reaches a defined target. CCDIK works by rotating a set of bones, typically called a "bone chain", on a single axis. Each bone is rotated to face the target from the tip (by default), which over a chain of bones allow it to rotate properly to reach the target. Because the bones only rotate on a single axis, CCDIK [i]can[/i] look more robotic than other IK solvers. [b]Note:[/b] The CCDIK modifier has [code]ccdik_joints[/code], which are the data objects that hold the data for each joint in the CCDIK chain. This is different from a bone! CCDIK joints hold the data needed for each bone in the bone chain used by CCDIK. CCDIK also fully supports angle constraints, allowing for more control over how a solution is met. diff --git a/doc/classes/SkeletonModification2DFABRIK.xml b/doc/classes/SkeletonModification2DFABRIK.xml index 16c22a45d3..82b99d20bd 100644 --- a/doc/classes/SkeletonModification2DFABRIK.xml +++ b/doc/classes/SkeletonModification2DFABRIK.xml @@ -4,7 +4,7 @@ A modification that uses FABRIK to manipulate a series of [Bone2D] nodes to reach a target. </brief_description> <description> - This [SkeletonModification2D] uses an algorithm called [b]F[/b]orward [b]A[/b]nd [b]B[/b]ackward [b]R[/b]eaching [b]I[/b]nverse [b]K[/b]inematics, or FABRIK, to rotate a bone chain so that it reaches a target. + This [SkeletonModification2D] uses an algorithm called Forward And Backward Reaching Inverse Kinematics, or FABRIK, to rotate a bone chain so that it reaches a target. FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other. Because of how FABRIK works, it often gives more natural results than those seen in [SkeletonModification2DCCDIK]. FABRIK also supports angle constraints, which are fully taken into account when solving. [b]Note:[/b] The FABRIK modifier has [code]fabrik_joints[/code], which are the data objects that hold the data for each joint in the FABRIK chain. This is different from [Bone2D] nodes! FABRIK joints hold the data needed for each [Bone2D] in the bone chain used by FABRIK. diff --git a/doc/classes/SkeletonModification3DCCDIK.xml b/doc/classes/SkeletonModification3DCCDIK.xml index ef3200a07a..55777ab0f4 100644 --- a/doc/classes/SkeletonModification3DCCDIK.xml +++ b/doc/classes/SkeletonModification3DCCDIK.xml @@ -4,7 +4,7 @@ A modification that uses CCDIK to manipulate a series of bones to reach a target. </brief_description> <description> - This [SkeletonModification3D] uses an algorithm called [b]C[/b]yclic [b]C[/b]oordinate [b]D[/b]escent [b]I[/b]nverse [b]K[/b]inematics, or CCDIK, to maniuplate a chain of bones in a Skeleton so it reaches a defined target. + This [SkeletonModification3D] uses an algorithm called Cyclic Coordinate Descent Inverse Kinematics, or CCDIK, to maniuplate a chain of bones in a Skeleton so it reaches a defined target. CCDIK works by rotating a set of bones, typically called a "bone chain", on a single axis. Each bone is rotated to face the target from the tip (by default), which over a chain of bones allow it to rotate properly to reach the target. Because the bones only rotate on a single axis, CCDIK [i]can[/i] look more robotic than other IK solvers. [b]Note:[/b] The CCDIK modifier has [code]ccdik_joints[/code], which are the data objects that hold the data for each joint in the CCDIK chain. This is different from a bone! CCDIK joints hold the data needed for each bone in the bone chain used by CCDIK. CCDIK also fully supports angle constraints, allowing for more control over how a solution is met. diff --git a/doc/classes/SkeletonModification3DFABRIK.xml b/doc/classes/SkeletonModification3DFABRIK.xml index 4c4e01e9d1..1c69ad7b3f 100644 --- a/doc/classes/SkeletonModification3DFABRIK.xml +++ b/doc/classes/SkeletonModification3DFABRIK.xml @@ -4,7 +4,7 @@ A modification that uses FABRIK to manipulate a series of bones to reach a target. </brief_description> <description> - This [SkeletonModification3D] uses an algorithm called [b]F[/b]orward [b]A[/b]nd [b]B[/b]ackward [b]R[/b]eaching [b]I[/b]nverse [b]K[/b]inematics, or FABRIK, to rotate a bone chain so that it reaches a target. + This [SkeletonModification3D] uses an algorithm called Forward And Backward Reaching Inverse Kinematics, or FABRIK, to rotate a bone chain so that it reaches a target. FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other. Because of how FABRIK works, it often gives more natural results than those seen in [SkeletonModification3DCCDIK], though FABRIK currently does not support joint constraints. [b]Note:[/b] The FABRIK modifier has [code]fabrik_joints[/code], which are the data objects that hold the data for each joint in the FABRIK chain. This is different from a bone! FABRIK joints hold the data needed for each bone in the bone chain used by FABRIK. @@ -67,7 +67,7 @@ <argument index="0" name="joint_idx" type="int" /> <description> Returns a boolean indiciating whether the FABRIK joint uses the target's [Basis] for its rotation. - [b]Note:[/b] this option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. + [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. </description> </method> <method name="get_fabrik_joint_use_tip_node" qualifiers="const"> @@ -132,7 +132,7 @@ <argument index="1" name="use_target_basis" type="bool" /> <description> Sets whether the FABRIK joint at [code]joint_idx[/code] uses the target's [Basis] for its rotation. - [b]Note:[/b] this option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. + [b]Note:[/b] This option is only available for the final bone in the FABRIK chain, with this setting being ignored for all other bones. </description> </method> <method name="set_fabrik_joint_use_tip_node"> diff --git a/doc/classes/SkeletonModification3DStackHolder.xml b/doc/classes/SkeletonModification3DStackHolder.xml index 138f9818ab..eeaa509ed7 100644 --- a/doc/classes/SkeletonModification3DStackHolder.xml +++ b/doc/classes/SkeletonModification3DStackHolder.xml @@ -5,7 +5,7 @@ </brief_description> <description> This [SkeletonModification3D] holds a reference to a [SkeletonModificationStack3D], allowing you to use multiple modification stacks on a single [Skeleton3D]. - [b]Note[/b]: The modifications in the held [SkeletonModificationStack3D] will only be executed if their execution mode matches the execution mode of the SkeletonModification3DStackHolder. + [b]Note:[/b] The modifications in the held [SkeletonModificationStack3D] will only be executed if their execution mode matches the execution mode of the SkeletonModification3DStackHolder. </description> <tutorials> </tutorials> diff --git a/doc/classes/SoftDynamicBody3D.xml b/doc/classes/SoftDynamicBody3D.xml index f999f77e78..fceebddf35 100644 --- a/doc/classes/SoftDynamicBody3D.xml +++ b/doc/classes/SoftDynamicBody3D.xml @@ -7,7 +7,7 @@ A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials. </description> <tutorials> - <link title="SoftBody">https://docs.godotengine.org/en/latest/tutorials/physics/soft_body.html</link> + <link title="SoftBody">$DOCS_URL/tutorials/physics/soft_body.html</link> </tutorials> <methods> <method name="add_collision_exception_with"> @@ -92,11 +92,11 @@ <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1"> The physics layers this SoftDynamicBody3D [b]is in[/b]. Collision objects can exist in one or more of 32 different layers. See also [member collision_mask]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> The physics layers this SoftDynamicBody3D [b]scans[/b]. Collision objects can scan one or more of 32 different layers. See also [member collision_layer]. - [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. 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. + [b]Note:[/b] Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.01"> </member> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 33d2b472b5..615f5e3586 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -39,6 +39,7 @@ <return type="LineEdit" /> <description> Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> </methods> diff --git a/doc/classes/SpotLight3D.xml b/doc/classes/SpotLight3D.xml index 8c10ec36a8..f9f9a62baa 100644 --- a/doc/classes/SpotLight3D.xml +++ b/doc/classes/SpotLight3D.xml @@ -7,7 +7,7 @@ A Spotlight is a type of [Light3D] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of [Light3D]. </description> <tutorials> - <link title="3D lights and shadows">https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> + <link title="3D lights and shadows">$DOCS_URL/tutorials/3d/lights_and_shadows.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <members> diff --git a/doc/classes/SpringArm3D.xml b/doc/classes/SpringArm3D.xml index 2cd8fa71cf..a54578cff4 100644 --- a/doc/classes/SpringArm3D.xml +++ b/doc/classes/SpringArm3D.xml @@ -41,7 +41,7 @@ </methods> <members> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The layers against which the collision check shall be done. 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. + The layers against which the collision check shall be done. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. </member> <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.01"> When the collision check is made, a candidate length for the SpringArm3D is given. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index b723c9f4d4..32abd1caea 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -60,7 +60,8 @@ If [code]true[/code], texture is flipped vertically. </member> <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)"> - A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. + A color value used to [i]multiply[/i] the texture's colors. Can be used for mood-coloring or to simulate the color of light. + [b]Note:[/b] If a [member GeometryInstance3D.material_override] is defined on the [SpriteBase3D], the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in [member modulate] will be ignored. For a [BaseMaterial3D], [member BaseMaterial3D.vertex_color_use_as_albedo] must be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/color] must be inserted in the shader's [code]fragment()[/code] function. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2(0, 0)"> The texture's drawing offset. diff --git a/doc/classes/StandardMaterial3D.xml b/doc/classes/StandardMaterial3D.xml index 8a36a734f1..1a8bf0e202 100644 --- a/doc/classes/StandardMaterial3D.xml +++ b/doc/classes/StandardMaterial3D.xml @@ -5,5 +5,6 @@ <description> </description> <tutorials> + <link title="Standard Material 3D">$DOCS_URL/tutorials/3d/standard_material_3d.html</link> </tutorials> </class> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index 0622626846..805f056289 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -173,7 +173,7 @@ <argument index="0" name="value" type="String" /> <description> Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. - Note: To put an ASCII string without prepending its size, you can use [method put_data]: + [b]Note:[/b] To put an ASCII string without prepending its size, you can use [method put_data]: [codeblocks] [gdscript] put_data("Hello world".to_ascii()) @@ -217,7 +217,7 @@ <argument index="0" name="value" type="String" /> <description> Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. - Note: To put an UTF-8 string without prepending its size, you can use [method put_data]: + [b]Note:[/b] To put an UTF-8 string without prepending its size, you can use [method put_data]: [codeblocks] [gdscript] put_data("Hello world".to_utf8()) diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 50389f912d..5e6e07fe36 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -8,7 +8,7 @@ [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. </description> <tutorials> - <link title="SSL certificates">https://docs.godotengine.org/en/latest/tutorials/networking/ssl_certificates.html</link> + <link title="SSL certificates">$DOCS_URL/tutorials/networking/ssl_certificates.html</link> </tutorials> <methods> <method name="accept_stream"> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 0991788483..ce902c1216 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -7,36 +7,38 @@ This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference-counted and use a copy-on-write approach, so passing them around is cheap in resources. </description> <tutorials> - <link title="GDScript format strings">https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_format_string.html</link> + <link title="GDScript format strings">$DOCS_URL/tutorials/scripting/gdscript/gdscript_format_string.html</link> </tutorials> - <methods> - <method name="String" qualifiers="constructor"> + <constructors> + <constructor name="String"> <return type="String" /> <description> Constructs an empty [String] ([code]""[/code]). </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="String" /> <description> Constructs a [String] as a copy of the given [String]. </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="NodePath" /> <description> Constructs a new String from the given [NodePath]. </description> - </method> - <method name="String" qualifiers="constructor"> + </constructor> + <constructor name="String"> <return type="String" /> <argument index="0" name="from" type="StringName" /> <description> Constructs a new String from the given [StringName]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="begins_with" qualifiers="const"> <return type="bool" /> <argument index="0" name="text" type="String" /> @@ -56,11 +58,11 @@ Converts a string containing a binary number into an integer. Binary strings can either be prefixed with [code]0b[/code] or not, and they can also start with a [code]-[/code] before the optional prefix. [codeblocks] [gdscript] - print("0x101".bin_to_int()) # Prints "5". + print("0b101".bin_to_int()) # Prints "5". print("101".bin_to_int()) # Prints "5". [/gdscript] [csharp] - GD.Print("0x101".BinToInt()); // Prints "5". + GD.Print("0b101".BinToInt()); // Prints "5". GD.Print("101".BinToInt()); // Prints "5". [/csharp] [/codeblocks] @@ -200,6 +202,19 @@ If the string is a valid file path, returns the filename. </description> </method> + <method name="get_slice" qualifiers="const"> + <return type="String" /> + <argument index="0" name="delimiter" type="String" /> + <argument index="1" name="slice" type="int" /> + <description> + Splits a string using a [code]delimiter[/code] and returns a substring at index [code]slice[/code]. Returns an empty string if the index doesn't exist. + This is a more performant alternative to [method split] for cases when you need only one element from the array at a fixed index. + Example: + [codeblock] + print("i/am/example/string".get_slice("/", 2)) # Prints 'example'. + [/codeblock] + </description> + </method> <method name="hash" qualifiers="const"> <return type="int" /> <description> @@ -443,82 +458,6 @@ <description> </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="StringName" /> - <description> - </description> - </method> - <method name="operator %" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="right" type="Variant" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="StringName" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="String" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="pad_decimals" qualifiers="const"> <return type="String" /> <argument index="0" name="digits" type="int" /> @@ -676,6 +615,7 @@ <description> Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. The [code]delimiter[/code] can be of any length. If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of [code]0[/code] means that all items are split. + If you need only one element from the array at a specific index, [method get_slice] is a more performant option. Example: [codeblocks] [gdscript] @@ -843,4 +783,82 @@ </description> </method> </methods> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + <operator name="operator %"> + <return type="String" /> + <argument index="0" name="right" type="Variant" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="String" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="StringName" /> + <description> + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="String" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="String" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml index 113195d91c..b32665a09f 100644 --- a/doc/classes/StringName.xml +++ b/doc/classes/StringName.xml @@ -8,60 +8,62 @@ </description> <tutorials> </tutorials> - <methods> - <method name="StringName" qualifiers="constructor"> + <constructors> + <constructor name="StringName"> <return type="StringName" /> <description> Constructs an empty [StringName]. </description> - </method> - <method name="StringName" qualifiers="constructor"> + </constructor> + <constructor name="StringName"> <return type="StringName" /> <argument index="0" name="from" type="StringName" /> <description> Constructs a [StringName] as a copy of the given [StringName]. </description> - </method> - <method name="StringName" qualifiers="constructor"> + </constructor> + <constructor name="StringName"> <return type="StringName" /> <argument index="0" name="from" type="String" /> <description> Creates a new [StringName] from the given [String]. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="String" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="StringName" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="String" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="StringName" /> <description> </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/SubViewport.xml b/doc/classes/SubViewport.xml index 28866699f6..f0b85cdad5 100644 --- a/doc/classes/SubViewport.xml +++ b/doc/classes/SubViewport.xml @@ -6,8 +6,8 @@ <description> </description> <tutorials> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> - <link title="Viewports tutorial index">https://docs.godotengine.org/en/latest/tutorials/viewports/index.html</link> + <link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> <link title="GUI in 3D Demo">https://godotengine.org/asset-library/asset/127</link> <link title="3D in 2D Demo">https://godotengine.org/asset-library/asset/128</link> <link title="2D in 3D Demo">https://godotengine.org/asset-library/asset/129</link> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index e5b03eb4d4..6a4ec08ec3 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -129,14 +129,14 @@ <return type="void" /> <argument index="0" name="flip" type="bool" default="false" /> <description> - Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. + Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. For correct display of normal-mapped surfaces, you will also have to generate tangents using [method generate_tangents]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. </description> </method> <method name="generate_tangents"> <return type="void" /> <description> - Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. + Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already (see [method generate_normals]). </description> </method> <method name="get_custom_format" qualifiers="const"> diff --git a/doc/classes/Tabs.xml b/doc/classes/TabBar.xml index ded4f0b32f..612f8fb740 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/TabBar.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Tabs" inherits="Control" version="4.0"> +<class name="TabBar" inherits="Control" version="4.0"> <brief_description> - Tabs control. + Tab bar control. </brief_description> <description> Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interacting with children. @@ -114,7 +114,7 @@ <method name="get_tabs_rearrange_group" qualifiers="const"> <return type="int" /> <description> - Returns the [Tabs]' rearrange group ID. + Returns the [TabBar]'s rearrange group ID. </description> </method> <method name="move_tab"> @@ -192,7 +192,7 @@ <return type="void" /> <argument index="0" name="group_id" type="int" /> <description> - Defines the rearrange group ID. Choose for each [Tabs] the same value to dragging tabs between [Tabs]. Enable drag with [member drag_to_rearrange_enabled]. + Defines the rearrange group ID. Choose for each [TabBar] the same value to dragging tabs between [TabBar]. Enable drag with [member drag_to_rearrange_enabled]. </description> </method> </methods> @@ -209,10 +209,10 @@ <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled" default="true"> if [code]true[/code], the mouse's scroll wheel can be used to navigate the scroll view. </member> - <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign" default="1"> + <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabBar.TabAlign" default="1"> The alignment of all tabs. See [enum TabAlign] for details. </member> - <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy" default="0"> + <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="TabBar.CloseButtonDisplayPolicy" default="0"> Sets when the close button will appear on the tabs. See [enum CloseButtonDisplayPolicy] for details. </member> </members> @@ -235,10 +235,19 @@ Emitted when a tab is clicked, even if it is the current tab. </description> </signal> - <signal name="tab_closed"> + <signal name="tab_close_pressed"> <argument index="0" name="tab" type="int" /> <description> - Emitted when a tab is closed. + Emitted when a tab's close button is pressed. + [b]Note:[/b] Tabs are not removed automatically once the close button is pressed, this behaviour needs to be programmed manually. For example: + [codeblocks] + [gdscript] + $TabBar.tab_close_pressed.connect($TabBar.remove_tab) + [/gdscript] + [csharp] + GetNode<TabBar>("TabBar").TabClosePressed += GetNode<TabBar>("TabBar").RemoveTab; + [/csharp] + [/codeblocks] </description> </signal> <signal name="tab_hovered"> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 4c50aa4e1f..ad1e5c0050 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -4,8 +4,9 @@ Tabbed container. </brief_description> <description> - Sets the active tab's [code]visible[/code] property to the value [code]true[/code]. Sets all other children's to [code]false[/code]. + Arranges [Control] children into a tabbed view, creating a tab for each one. The active tab's corresponding [Control] has its [code]visible[/code] property set to [code]true[/code], and all other children's to [code]false[/code]. Ignores non-[Control] children. + [b]Note:[/b] The drawing of the clickable tabs themselves is handled by this node. Adding [TabBar]s as children is not needed. </description> <tutorials> </tutorials> @@ -20,6 +21,7 @@ <return type="Popup" /> <description> Returns the [Popup] node instance if one has been set already with [method set_popup]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_previous_tab" qualifiers="const"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 6a38c1a117..16d8595b4e 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -41,6 +41,13 @@ Override this method to define what happens when the user performs a paste operation. </description> </method> + <method name="_paste_primary_clipboard" qualifiers="virtual"> + <return type="void" /> + <description> + Override this method to define what happens when the user performs a paste operation with middle mouse button. + [b]Note:[/b] This method is only implemented on Linux. + </description> + </method> <method name="add_gutter"> <return type="void" /> <argument index="0" name="at" type="int" default="-1" /> @@ -226,8 +233,9 @@ <method name="get_line_column_at_pos" qualifiers="const"> <return type="Vector2i" /> <argument index="0" name="position" type="Vector2i" /> + <argument index="1" name="allow_out_of_bounds" type="bool" default="true" /> <description> - Returns the line and column at the given position. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. + Returns the line and column at the given position. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If [code]allow_out_of_bounds[/code] is [code]false[/code] and the position is not over the text, both vector values will be set to [code]-1[/code]. </description> </method> <method name="get_line_count" qualifiers="const"> @@ -314,6 +322,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_minimap_line_at_pos" qualifiers="const"> @@ -353,6 +362,24 @@ Returns OpenType feature [code]tag[/code]. </description> </method> + <method name="get_pos_at_line_column" qualifiers="const"> + <return type="Vector2i" /> + <argument index="0" name="line" type="int" /> + <argument index="1" name="column" type="int" /> + <description> + Returns the local position for the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] of the returned vector equal [code]-1[/code], the position is outside of the viewable area of the control. + [b]Note:[/b] The Y position corresponds to the bottom side of the line. Use [method get_rect_at_line_column] to get the top side position. + </description> + </method> + <method name="get_rect_at_line_column" qualifiers="const"> + <return type="Rect2i" /> + <argument index="0" name="line" type="int" /> + <argument index="1" name="column" type="int" /> + <description> + Returns the local position and size for the grapheme at the given [code]line[/code] and [code]column[/code]. If [code]x[/code] or [code]y[/code] position of the returned rect equal [code]-1[/code], the position is outside of the viewable area of the control. + [b]Note:[/b] The Y position of the returned rect corresponds to the top side of the line, unlike [method get_pos_at_line_column] which returns the bottom side. + </description> + </method> <method name="get_saved_version" qualifiers="const"> <return type="int" /> <description> @@ -445,6 +472,14 @@ Returns the number of visible lines, including wrapped text. </description> </method> + <method name="get_visible_line_count_in_range" qualifiers="const"> + <return type="int" /> + <argument index="0" name="from_line" type="int" /> + <argument index="1" name="to_line" type="int" /> + <description> + Returns the total number of visible + wrapped lines between the two lines. + </description> + </method> <method name="get_word_at_pos" qualifiers="const"> <return type="String" /> <argument index="0" name="position" type="Vector2" /> @@ -599,7 +634,7 @@ <argument index="3" name="to_column" type="int" /> <description> Removes text between the given positions. - [b]Note:[/b]This does not adjust the caret or selection, which as a result it can end up in an invalid position. + [b]Note:[/b] This does not adjust the caret or selection, which as a result it can end up in an invalid position. </description> </method> <method name="search" qualifiers="const"> @@ -902,7 +937,7 @@ </member> <member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false"> Allow moving caret, selecting and removing the individual composite character components. - Note: [kbd]Backspace[/kbd] is always removing individual composite character components. + [b]Note:[/b] [kbd]Backspace[/kbd] is always removing individual composite character components. </member> <member name="caret_move_on_right_click" type="bool" setter="set_move_caret_on_right_click_enabled" getter="is_move_caret_on_right_click_enabled" default="true"> If [code]true[/code], a right-click moves the caret at the mouse position before displaying the context menu. @@ -914,6 +949,9 @@ <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="true"> If [code]true[/code], a right-click displays the context menu. </member> + <member name="deselect_on_focus_loss_enabled" type="bool" setter="set_deselect_on_focus_loss_enabled" getter="is_deselect_on_focus_loss_enabled" default="true"> + If [code]true[/code], the selected text will be deselected when focus is lost. + </member> <member name="draw_control_chars" type="bool" setter="set_draw_control_chars" getter="get_draw_control_chars" default="false"> If [code]true[/code], control characters are displayed. </member> @@ -936,7 +974,11 @@ <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. </member> - <member name="minimap_draw" type="bool" setter="draw_minimap" getter="is_drawing_minimap" default="false"> + <member name="middle_mouse_paste_enabled" type="bool" setter="set_middle_mouse_paste_enabled" getter="is_middle_mouse_paste_enabled" default="true"> + If [code]false[/code], using middle mouse button to paste clipboard will be disabled. + [b]Note:[/b] This method is only implemented on Linux. + </member> + <member name="minimap_draw" type="bool" setter="set_draw_minimap" getter="is_drawing_minimap" default="false"> If [code]true[/code], a minimap is shown, providing an outline of your source code. </member> <member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80"> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index aa35acdbd2..a7122b827e 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -199,7 +199,7 @@ Returns width (for horizontal layout) or height (for vertical) of the line of text. </description> </method> - <method name="get_non_wraped_size" qualifiers="const"> + <method name="get_non_wrapped_size" qualifiers="const"> <return type="Vector2" /> <description> Returns the size of the bounding box of the paragraph, without line breaks. @@ -278,10 +278,13 @@ <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> - <member name="flags" type="int" setter="set_flags" getter="get_flags" default="51"> + <member name="flags" type="int" setter="set_flags" getter="get_flags" default="99"> Line breaking and alignment rules. For more info see [TextServer]. </member> <member name="max_lines_visible" type="int" setter="set_max_lines_visible" getter="get_max_lines_visible" default="-1"> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 7fe9278f2c..512078c56c 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextServer" inherits="Object" version="4.0"> +<class name="TextServer" inherits="RefCounted" version="4.0"> <brief_description> Interface for the fonts and complex text layouts. </brief_description> @@ -21,8 +21,8 @@ <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. - Note: Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. - Note: Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. </description> </method> <method name="draw_hex_code_box" qualifiers="const"> @@ -41,7 +41,8 @@ <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <description> - Removes all rendered glyphs information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. + Removes all rendered glyphs information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. </description> </method> <method name="font_clear_kerning_map"> @@ -64,7 +65,8 @@ <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <description> - Removes all textures from font cache entry. Note: This function will not remove glyphs associated with the texture, use [method font_remove_glyph] to remove them manually. + Removes all textures from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method font_remove_glyph] to remove them manually. </description> </method> <method name="font_draw_glyph" qualifiers="const"> @@ -77,7 +79,7 @@ <argument index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - Note: Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. + [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. </description> </method> <method name="font_draw_glyph_outline" qualifiers="const"> @@ -91,7 +93,7 @@ <argument index="6" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - Note: Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. + [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method shaped_text_get_glyphs] or [method font_get_glyph_index]. </description> </method> <method name="font_get_ascent" qualifiers="const"> @@ -129,7 +131,8 @@ <argument index="1" name="size" type="int" /> <argument index="2" name="glyph" type="int" /> <description> - Returns glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + Returns glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> <method name="font_get_glyph_contours" qualifiers="const"> @@ -251,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" /> @@ -297,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" /> @@ -404,7 +428,8 @@ <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="glyph" type="int" /> <description> - Removes specified rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. + Removes specified rendered glyph information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method font_remove_texture] to remove them manually. </description> </method> <method name="font_remove_kerning"> @@ -446,7 +471,8 @@ <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="texture_index" type="int" /> <description> - Removes specified texture from font cache entry. Note: This function will not remove glyphs associated with the texture, remove them manually, using [method font_remove_glyph]. + Removes specified texture from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method font_remove_glyph]. </description> </method> <method name="font_render_glyph"> @@ -487,8 +513,8 @@ </method> <method name="font_set_data"> <return type="void" /> - <argument index="0" name="data" type="RID" /> - <argument index="1" name="arg1" type="PackedByteArray" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data" type="PackedByteArray" /> <description> Sets font source data, e.g contents of the dynamic font source file. </description> @@ -523,7 +549,7 @@ <argument index="0" name="oversampling" type="float" /> <description> Sets oversampling factor, shared by all font in the TextServer. - Note: This value can be automaticaly changed by display server. + [b]Note:[/b] This value can be automaticaly changed by display server. </description> </method> <method name="font_set_glyph_advance"> @@ -533,7 +559,8 @@ <argument index="2" name="glyph" type="int" /> <argument index="3" name="advance" type="Vector2" /> <description> - Sets glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + Sets glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> <method name="font_set_glyph_offset"> @@ -628,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" /> @@ -664,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" /> @@ -714,12 +765,14 @@ <return type="Dictionary" /> <argument index="0" name="font_rid" type="RID" /> <description> + Returns the dictionary of the supported OpenType features. </description> </method> <method name="font_supported_variation_list" qualifiers="const"> <return type="Dictionary" /> <argument index="0" name="font_rid" type="RID" /> <description> + Returns the dictionary of the supported OpenType variation coordinates. </description> </method> <method name="format_number" qualifiers="const"> @@ -737,6 +790,12 @@ Frees an object created by this [TextServer]. </description> </method> + <method name="get_features" qualifiers="const"> + <return type="int" /> + <description> + Returns text server features, see [enum Feature]. + </description> + </method> <method name="get_hex_code_box_size" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="size" type="int" /> @@ -751,6 +810,18 @@ Returns the name of the server interface. </description> </method> + <method name="get_support_data_filename" qualifiers="const"> + <return type="String" /> + <description> + Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. + </description> + </method> + <method name="get_support_data_info" qualifiers="const"> + <return type="String" /> + <description> + Returns TextServer database (e.g. ICU break iterators and dictionaries) description. + </description> + </method> <method name="has"> <return type="bool" /> <argument index="0" name="rid" type="RID" /> @@ -758,14 +829,14 @@ Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. </description> </method> - <method name="has_feature"> + <method name="has_feature" qualifiers="const"> <return type="bool" /> <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> <description> Returns [code]true[/code] if the server supports a feature. </description> </method> - <method name="is_locale_right_to_left"> + <method name="is_locale_right_to_left" qualifiers="const"> <return type="bool" /> <argument index="0" name="locale" type="String" /> <description> @@ -777,7 +848,7 @@ <argument index="0" name="filename" type="String" /> <description> Loads optional TextServer database (e.g. ICU break iterators and dictionaries). - Note: This function should be called before any other TextServer functions used, otherwise it won't have any effect. + [b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect. </description> </method> <method name="name_to_tag" qualifiers="const"> @@ -802,6 +873,14 @@ Returns percent sign used in the [code]language[/code]. </description> </method> + <method name="save_support_data" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. + [b]Note:[/b] This function is used by during project export, to include TextServer database. + </description> + </method> <method name="shaped_text_add_object"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> @@ -872,7 +951,7 @@ <argument index="0" name="shaped" type="RID" /> <description> Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). - Note: overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. + [b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. </description> </method> <method name="shaped_text_get_carets" qualifiers="const"> @@ -883,12 +962,19 @@ 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" /> <description> Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). - Note: overall descent can be higher than font descent, if some glyphs are displaced from the baseline. + [b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline. </description> </method> <method name="shaped_text_get_direction" qualifiers="const"> @@ -898,7 +984,7 @@ Returns direction of the text. </description> </method> - <method name="shaped_text_get_dominant_direciton_in_range" qualifiers="const"> + <method name="shaped_text_get_dominant_direction_in_range" qualifiers="const"> <return type="int" enum="TextServer.Direction" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="start" type="int" /> @@ -907,30 +993,66 @@ Returns dominant direction of in the range of text. </description> </method> + <method name="shaped_text_get_ellipsis_glyph_count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the ellipsis. + </description> + </method> + <method name="shaped_text_get_ellipsis_glyphs" qualifiers="const"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns array of the glyphs in the ellipsis. + </description> + </method> + <method name="shaped_text_get_ellipsis_pos" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the ellipsis. + </description> + </method> + <method name="shaped_text_get_glyph_count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the buffer. + </description> + </method> <method name="shaped_text_get_glyphs" qualifiers="const"> <return type="Array" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns text glyphs. + Returns text glyphs in the visual order. + </description> + </method> + <method name="shaped_text_get_grapheme_bounds" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character's bounds as offsets from the start of the line. </description> </method> <method name="shaped_text_get_line_breaks" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="width" type="float" /> <argument index="2" name="start" type="int" default="0" /> - <argument index="3" name="break_flags" type="int" default="48" /> + <argument index="3" name="break_flags" type="int" default="96" /> <description> Breaks text to the lines and returns character ranges for each line. </description> </method> <method name="shaped_text_get_line_breaks_adv" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="width" type="PackedFloat32Array" /> <argument index="2" name="start" type="int" default="0" /> <argument index="3" name="once" type="bool" default="true" /> - <argument index="4" name="break_flags" type="int" default="48" /> + <argument index="4" name="break_flags" type="int" default="96" /> <description> Breaks text to the lines and columns. Returns character ranges for each segment. </description> @@ -976,7 +1098,7 @@ <argument index="0" name="shaped" type="RID" /> <description> Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. - Note: If set to [code]false[/code], nothing is displayed in place of invalid characters. + [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. </description> </method> <method name="shaped_text_get_range" qualifiers="const"> @@ -987,7 +1109,7 @@ </description> </method> <method name="shaped_text_get_selection" qualifiers="const"> - <return type="Array" /> + <return type="PackedVector2Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="start" type="int" /> <argument index="2" name="end" type="int" /> @@ -1002,6 +1124,13 @@ Returns size of the text. </description> </method> + <method name="shaped_text_get_trim_pos" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the trim. + </description> + </method> <method name="shaped_text_get_underline_position" qualifiers="const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> @@ -1024,8 +1153,9 @@ </description> </method> <method name="shaped_text_get_word_breaks" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="grapheme_flags" type="int" /> <description> Breaks text into words and returns array of character ranges. </description> @@ -1053,7 +1183,7 @@ Returns [code]true[/code] if buffer is successfully shaped. </description> </method> - <method name="shaped_text_next_grapheme_pos"> + <method name="shaped_text_next_grapheme_pos" qualifiers="const"> <return type="int" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="pos" type="int" /> @@ -1070,7 +1200,7 @@ Trims text if it exceeds the given width. </description> </method> - <method name="shaped_text_prev_grapheme_pos"> + <method name="shaped_text_prev_grapheme_pos" qualifiers="const"> <return type="int" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="pos" type="int" /> @@ -1097,13 +1227,21 @@ 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" /> <argument index="1" name="direction" type="int" enum="TextServer.Direction" default="0" /> <description> Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. - Note: Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. </description> </method> <method name="shaped_text_set_orientation"> @@ -1112,7 +1250,7 @@ <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" default="0" /> <description> Sets desired text orientation. - Note: Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. </description> </method> <method name="shaped_text_set_preserve_control"> @@ -1136,7 +1274,14 @@ <argument index="0" name="shaped" type="RID" /> <description> Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. - Note: It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. + [b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. + </description> + </method> + <method name="shaped_text_sort_logical"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text glyphs in the logical order. </description> </method> <method name="shaped_text_substr" qualifiers="const"> @@ -1156,6 +1301,13 @@ Aligns shaped text to the given tab-stops. </description> </method> + <method name="strip_diacritics" qualifiers="const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <description> + Strips diacritics from the string. + </description> + </method> <method name="tag_to_name" qualifiers="const"> <return type="String" /> <argument index="0" name="tag" type="int" /> @@ -1196,18 +1348,24 @@ <constant name="JUSTIFICATION_AFTER_LAST_TAB" value="8" enum="JustificationFlag"> Only apply justification to the part of the text after the last tab. </constant> + <constant name="JUSTIFICATION_CONSTRAIN_ELLIPSIS" value="16" enum="JustificationFlag"> + Apply justification to the trimmed line with ellipsis. + </constant> <constant name="BREAK_NONE" value="0" enum="LineBreakFlag"> Do not break the line. </constant> - <constant name="BREAK_MANDATORY" value="16" enum="LineBreakFlag"> + <constant name="BREAK_MANDATORY" value="32" enum="LineBreakFlag"> Break the line at the line mandatory break characters (e.g. [code]"\n"[/code]). </constant> - <constant name="BREAK_WORD_BOUND" value="32" enum="LineBreakFlag"> + <constant name="BREAK_WORD_BOUND" value="64" enum="LineBreakFlag"> Break the line between the words. </constant> - <constant name="BREAK_GRAPHEME_BOUND" value="64" enum="LineBreakFlag"> + <constant name="BREAK_GRAPHEME_BOUND" value="128" enum="LineBreakFlag"> Break the line between any unconnected graphemes. </constant> + <constant name="BREAK_WORD_BOUND_ADAPTIVE" value="320" enum="LineBreakFlag"> + Break the line between the words, or any unconnected graphemes if line is too short to fit the whole word. + </constant> <constant name="OVERRUN_NO_TRIMMING" value="0" enum="TextOverrunFlag"> No trimming is performed. </constant> @@ -1223,6 +1381,11 @@ <constant name="OVERRUN_ENFORCE_ELLIPSIS" value="8" enum="TextOverrunFlag"> Determines whether the ellipsis at the end of the text is enforced and may not be hidden. </constant> + <constant name="OVERRUN_JUSTIFICATION_AWARE" value="16" enum="TextOverrunFlag"> + </constant> + <constant name="GRAPHEME_IS_VALID" value="1" enum="GraphemeFlag"> + Grapheme is supprted by the font, and can be drawn. + </constant> <constant name="GRAPHEME_IS_RTL" value="2" enum="GraphemeFlag"> Grapheme is part of right-to-left or bottom-to-top run. </constant> @@ -1307,5 +1470,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 new file mode 100644 index 0000000000..32f8107e0a --- /dev/null +++ b/doc/classes/TextServerExtension.xml @@ -0,0 +1,1336 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextServerExtension" inherits="TextServer" version="4.0"> + <brief_description> + Base class for TextServer custom implementations (plugins). + </brief_description> + <description> + External TextServer implementations should inherit from this class. + </description> + <tutorials> + </tutorials> + <methods> + <method name="_create_font" qualifiers="virtual"> + <return type="RID" /> + <description> + Creates new, empty font cache entry resource. To free the resulting resourec, use [method _free] method. + </description> + </method> + <method name="_create_shaped_text" qualifiers="virtual"> + <return type="RID" /> + <argument index="0" name="direction" type="int" enum="TextServer.Direction" /> + <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <description> + Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method _free] method. + [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + </description> + </method> + <method name="_draw_hex_code_box" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="index" type="int" /> + <argument index="4" name="color" type="Color" /> + <description> + Draws box displaying character hexadecimal code. Used for replacing missing characters. + </description> + </method> + <method name="_font_clear_glyphs" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes all rendered glyphs information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. + </description> + </method> + <method name="_font_clear_kerning_map" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Removes all kerning overrides. + </description> + </method> + <method name="_font_clear_size_cache" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Removes all font sizes from the cache entry + </description> + </method> + <method name="_font_clear_textures" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes all textures from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method _font_remove_glyph] to remove them manually. + </description> + </method> + <method name="_font_draw_glyph" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="pos" type="Vector2" /> + <argument index="4" name="index" type="int" /> + <argument index="5" name="color" type="Color" /> + <description> + Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. + [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. + </description> + </method> + <method name="_font_draw_glyph_outline" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="outline_size" type="int" /> + <argument index="4" name="pos" type="Vector2" /> + <argument index="5" name="index" type="int" /> + <argument index="6" name="color" type="Color" /> + <description> + Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. + [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. + </description> + </method> + <method name="_font_get_ascent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="_font_get_descent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns the font descent (number of pixels below the baseline). + </description> + </method> + <method name="_font_get_fixed_size" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns bitmap font fixed size. + </description> + </method> + <method name="_font_get_global_oversampling" qualifiers="virtual const"> + <return type="float" /> + <description> + Returns the font oversampling factor, shared by all fonts in the TextServer. + </description> + </method> + <method name="_font_get_glyph_advance" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. + </description> + </method> + <method name="_font_get_glyph_contours" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="index" type="int" /> + <description> + Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: + [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum TextServer.ContourPointTag] values. + [code]contours[/code] - [PackedInt32Array], containing indices the end points of each contour. + [code]orientation[/code] - [bool], contour orientation. If [code]true[/code], clockwise contours must be filled. + </description> + </method> + <method name="_font_get_glyph_index" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="char" type="int" /> + <argument index="3" name="variation_selector" type="int" /> + <description> + Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. + </description> + </method> + <method name="_font_get_glyph_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Returns list of rendered glyphs in the cache entry. + </description> + </method> + <method name="_font_get_glyph_offset" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns glyph offset from the baseline. + </description> + </method> + <method name="_font_get_glyph_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns size of the glyph. + </description> + </method> + <method name="_font_get_glyph_texture_idx" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns index of the cache texture containing the glyph. + </description> + </method> + <method name="_font_get_glyph_uv_rect" qualifiers="virtual const"> + <return type="Rect2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns rectangle in the cache texture containing the glyph. + </description> + </method> + <method name="_font_get_hinting" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the font hinting mode. Used by dynamic fonts only. + </description> + </method> + <method name="_font_get_kerning" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <description> + Returns kerning for the pair of glyphs. + </description> + </method> + <method name="_font_get_kerning_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns list of the kerning overrides. + </description> + </method> + <method name="_font_get_language_support_override" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Returns [code]true[/code] if support override is enabled for the [code]language[/code]. + </description> + </method> + <method name="_font_get_language_support_overrides" qualifiers="virtual"> + <return type="PackedStringArray" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns list of language support overrides. + </description> + </method> + <method name="_font_get_msdf_pixel_range" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Return the width of the range around the shape between the minimum and maximum representable signed distance. + </description> + </method> + <method name="_font_get_msdf_size" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + 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" /> + <description> + Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. + </description> + </method> + <method name="_font_get_scale" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns scaling factor of the color bitmap font. + </description> + </method> + <method name="_font_get_script_support_override" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Returns [code]true[/code] if support override is enabled for the [code]script[/code]. + </description> + </method> + <method name="_font_get_script_support_overrides" qualifiers="virtual"> + <return type="PackedStringArray" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns list of script support overrides. + </description> + </method> + <method name="_font_get_size_cache_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Return list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. + </description> + </method> + <method name="_font_get_spacing" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> + <description> + 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" /> + <description> + Returns a string containing all the characters available in the font. + </description> + </method> + <method name="_font_get_texture_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Returns number of textures used by font cache entry. + </description> + </method> + <method name="_font_get_texture_image" qualifiers="virtual const"> + <return type="Image" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Returns font cache texture image data. + </description> + </method> + <method name="_font_get_texture_offsets" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. + </description> + </method> + <method name="_font_get_underline_position" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns pixel offset of the underline below the baseline. + </description> + </method> + <method name="_font_get_underline_thickness" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns thickness of the underline in pixels. + </description> + </method> + <method name="_font_get_variation_coordinates" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns variation coordinates for the specified font cache entry. See [method _font_supported_variation_list] for more info. + </description> + </method> + <method name="_font_has_char" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="char" type="int" /> + <description> + Return [code]true[/code] if a Unicode [code]char[/code] is available in the font. + </description> + </method> + <method name="_font_is_antialiased" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. + </description> + </method> + <method name="_font_is_force_autohinter" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if auto-hinting is supported and preffered over font built-in hinting. Used by dynamic fonts only. + </description> + </method> + <method name="_font_is_language_supported" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). + </description> + </method> + <method name="_font_is_multichannel_signed_distance_field" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. + </description> + </method> + <method name="_font_is_script_supported" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Returns [code]true[/code], if font supports given script (ISO 15924 code). + </description> + </method> + <method name="_font_remove_glyph" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Removes specified rendered glyph information from the cache entry. + [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. + </description> + </method> + <method name="_font_remove_kerning" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <description> + Removes kerning override for the pair of glyphs. + </description> + </method> + <method name="_font_remove_language_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Remove language support override. + </description> + </method> + <method name="_font_remove_script_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Removes script support override. + </description> + </method> + <method name="_font_remove_size_cache" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes specified font size from the cache entry. + </description> + </method> + <method name="_font_remove_texture" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Removes specified texture from font cache entry. + [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method _font_remove_glyph]. + </description> + </method> + <method name="_font_render_glyph" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="index" type="int" /> + <description> + Renders specified glyph the the font cache texture. + </description> + </method> + <method name="_font_render_range" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="end" type="int" /> + <description> + Renders the range of characters to the font cache texture. + </description> + </method> + <method name="_font_set_antialiased" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="antialiased" type="bool" /> + <description> + If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_ascent" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="ascent" type="float" /> + <description> + Sets the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="_font_set_data" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data" type="PackedByteArray" /> + <description> + Sets font source data, e.g contents of the dynamic font source file. + </description> + </method> + <method name="_font_set_data_ptr" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data_ptr" type="const uint8_t*" /> + <argument index="2" name="data_size" type="int" /> + <description> + Sets the font descent (number of pixels below the baseline). + </description> + </method> + <method name="_font_set_descent" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="descent" type="float" /> + <description> + Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. + </description> + </method> + <method name="_font_set_fixed_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="fixed_size" type="int" /> + <description> + If set to [code]true[/code] auto-hinting is preffered over font built-in hinting. + </description> + </method> + <method name="_font_set_force_autohinter" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="force_autohinter" type="bool" /> + <description> + </description> + </method> + <method name="_font_set_global_oversampling" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="oversampling" type="float" /> + <description> + Sets oversampling factor, shared by all font in the TextServer. + [b]Note:[/b] This value can be automaticaly changed by display server. + </description> + </method> + <method name="_font_set_glyph_advance" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="advance" type="Vector2" /> + <description> + Sets glyph advance (offset of the next glyph). + [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. + </description> + </method> + <method name="_font_set_glyph_offset" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="offset" type="Vector2" /> + <description> + Sets glyph offset from the baseline. + </description> + </method> + <method name="_font_set_glyph_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="gl_size" type="Vector2" /> + <description> + Sets size of the glyph. + </description> + </method> + <method name="_font_set_glyph_texture_idx" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="texture_idx" type="int" /> + <description> + Sets index of the cache texture containing the glyph. + </description> + </method> + <method name="_font_set_glyph_uv_rect" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="uv_rect" type="Rect2" /> + <description> + Sets rectangle in the cache texture containing the glyph. + </description> + </method> + <method name="_font_set_hinting" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="hinting" type="int" enum="TextServer.Hinting" /> + <description> + Sets font hinting mode. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_kerning" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <argument index="3" name="kerning" type="Vector2" /> + <description> + Sets kerning for the pair of glyphs. + </description> + </method> + <method name="_font_set_language_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <argument index="2" name="supported" type="bool" /> + <description> + Adds override for [method _font_is_language_supported]. + </description> + </method> + <method name="_font_set_msdf_pixel_range" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf_pixel_range" type="int" /> + <description> + Sets the width of the range around the shape between the minimum and maximum representable signed distance. + </description> + </method> + <method name="_font_set_msdf_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf_size" type="int" /> + <description> + Sets source font size used to generate MSDF textures. + </description> + </method> + <method name="_font_set_multichannel_signed_distance_field" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf" type="bool" /> + <description> + 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" /> + <argument index="1" name="oversampling" type="float" /> + <description> + Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_scale" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="scale" type="float" /> + <description> + Sets scaling factor of the color bitmap font. + </description> + </method> + <method name="_font_set_script_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <argument index="2" name="supported" type="bool" /> + <description> + Adds override for [method _font_is_script_supported]. + </description> + </method> + <method name="_font_set_spacing" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> + <argument index="3" name="value" type="int" /> + <description> + 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" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <argument index="3" name="image" type="Image" /> + <description> + Sets font cache texture image data. + </description> + </method> + <method name="_font_set_texture_offsets" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <argument index="3" name="offset" type="PackedInt32Array" /> + <description> + Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. + </description> + </method> + <method name="_font_set_underline_position" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="underline_position" type="float" /> + <description> + Sets pixel offset of the underline below the baseline. + </description> + </method> + <method name="_font_set_underline_thickness" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="underline_thickness" type="float" /> + <description> + Sets thickness of the underline in pixels. + </description> + </method> + <method name="_font_set_variation_coordinates" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="variation_coordinates" type="Dictionary" /> + <description> + Sets variation coordinates for the specified font cache entry. See [method _font_supported_variation_list] for more info. + </description> + </method> + <method name="_font_supported_feature_list" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the dictionary of the supported OpenType features. + </description> + </method> + <method name="_font_supported_variation_list" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the dictionary of the supported OpenType variation coordinates. + </description> + </method> + <method name="_format_number" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <argument index="1" name="language" type="String" /> + <description> + Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. + </description> + </method> + <method name="_free" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="rid" type="RID" /> + <description> + Frees an object created by this [TextServer]. + </description> + </method> + <method name="_get_features" qualifiers="virtual const"> + <return type="int" /> + <description> + Returns text server features, see [enum TextServer.Feature]. + </description> + </method> + <method name="_get_hex_code_box_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="size" type="int" /> + <argument index="1" name="index" type="int" /> + <description> + Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). + </description> + </method> + <method name="_get_name" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns the name of the server interface. + </description> + </method> + <method name="_get_support_data_filename" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. + </description> + </method> + <method name="_get_support_data_info" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns TextServer database (e.g. ICU break iterators and dictionaries) description. + </description> + </method> + <method name="_has" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="rid" type="RID" /> + <description> + Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. + </description> + </method> + <method name="_has_feature" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> + <description> + Returns [code]true[/code] if the server supports a feature. + </description> + </method> + <method name="_is_locale_right_to_left" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="locale" type="String" /> + <description> + Returns [code]true[/code] if locale is right-to-left. + </description> + </method> + <method name="_load_support_data" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Loads optional TextServer database (e.g. ICU break iterators and dictionaries). + [b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect. + </description> + </method> + <method name="_name_to_tag" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="name" type="String" /> + <description> + Converts readable feature, variation, script or language name to OpenType tag. + </description> + </method> + <method name="_parse_number" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <argument index="1" name="language" type="String" /> + <description> + Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). + </description> + </method> + <method name="_percent_sign" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="language" type="String" /> + <description> + Returns percent sign used in the [code]language[/code]. + </description> + </method> + <method name="_save_support_data" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. + [b]Note:[/b] This function is used by during project export, to include TextServer database. + </description> + </method> + <method name="_shaped_text_add_object" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <argument index="2" name="size" type="Vector2" /> + <argument index="3" name="inline_align" type="int" enum="InlineAlign" /> + <argument index="4" name="length" type="int" /> + <description> + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. + </description> + </method> + <method name="_shaped_text_add_string" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="text" type="String" /> + <argument index="2" name="fonts" type="Array" /> + <argument index="3" name="size" type="int" /> + <argument index="4" name="opentype_features" type="Dictionary" /> + <argument index="5" name="language" type="String" /> + <description> + Adds text span and font to draw it to the text buffer. + </description> + </method> + <method name="_shaped_text_clear" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Clears text buffer (removes text and inline objects). + </description> + </method> + <method name="_shaped_text_draw" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="clip_l" type="float" /> + <argument index="4" name="clip_r" type="float" /> + <argument index="5" name="color" type="Color" /> + <description> + Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). + </description> + </method> + <method name="_shaped_text_draw_outline" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="clip_l" type="float" /> + <argument index="4" name="clip_r" type="float" /> + <argument index="5" name="outline_size" type="int" /> + <argument index="6" name="color" type="Color" /> + <description> + Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). + </description> + </method> + <method name="_shaped_text_fit_to_width" qualifiers="virtual"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="jst_flags" type="int" /> + <description> + Adjusts text with to fit to specified width, returns new text width + </description> + </method> + <method name="_shaped_text_get_ascent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). + [b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. + </description> + </method> + <method name="_shaped_text_get_carets" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="position" type="int" /> + <argument index="2" name="caret" type="CaretInfo*" /> + <description> + 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" /> + <description> + Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). + [b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline. + </description> + </method> + <method name="_shaped_text_get_direction" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns direction of the text. + </description> + </method> + <method name="_shaped_text_get_dominant_direction_in_range" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="end" type="int" /> + <description> + Returns dominant direction of in the range of text. + </description> + </method> + <method name="_shaped_text_get_ellipsis_glyph_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the ellipsis. + </description> + </method> + <method name="_shaped_text_get_ellipsis_glyphs" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Returns array of the glyphs in the ellipsis. + </description> + </method> + <method name="_shaped_text_get_ellipsis_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the ellipsis. + </description> + </method> + <method name="_shaped_text_get_glyph_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text glyphs count. + </description> + </method> + <method name="_shaped_text_get_glyphs" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Copies text glyphs in the visual order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + </description> + </method> + <method name="_shaped_text_get_grapheme_bounds" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character's bounds as offsets from the start of the line. + </description> + </method> + <method name="_shaped_text_get_line_breaks" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="break_flags" type="int" /> + <description> + Breaks text to the lines and returns character ranges for each line. + </description> + </method> + <method name="_shaped_text_get_line_breaks_adv" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="PackedFloat32Array" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="once" type="bool" /> + <argument index="4" name="break_flags" type="int" /> + <description> + Breaks text to the lines and columns. Returns character ranges for each segment. + </description> + </method> + <method name="_shaped_text_get_object_rect" qualifiers="virtual const"> + <return type="Rect2" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <description> + Returns bounding rectangle of the inline object. + </description> + </method> + <method name="_shaped_text_get_objects" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns array of inline objects. + </description> + </method> + <method name="_shaped_text_get_orientation" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text orientation. + </description> + </method> + <method name="_shaped_text_get_parent" qualifiers="virtual const"> + <return type="RID" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Sets text orientation. + </description> + </method> + <method name="_shaped_text_get_preserve_control" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if text buffer is configured to display control characters. + </description> + </method> + <method name="_shaped_text_get_preserve_invalid" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. + [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. + </description> + </method> + <method name="_shaped_text_get_range" qualifiers="virtual const"> + <return type="Vector2i" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns substring buffer character range in the parent buffer. + </description> + </method> + <method name="_shaped_text_get_selection" qualifiers="virtual const"> + <return type="PackedVector2Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="end" type="int" /> + <description> + Returns selection rectangles for the specified character range. + </description> + </method> + <method name="_shaped_text_get_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns size of the text. + </description> + </method> + <method name="_shaped_text_get_trim_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns ellipsis and trim positions. + </description> + </method> + <method name="_shaped_text_get_underline_position" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns pixel offset of the underline below the baseline. + </description> + </method> + <method name="_shaped_text_get_underline_thickness" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns thickness of the underline. + </description> + </method> + <method name="_shaped_text_get_width" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns width (for horizontal layout) or height (for vertical) of the text. + </description> + </method> + <method name="_shaped_text_get_word_breaks" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="grapheme_flags" type="int" /> + <description> + Breaks text into words and returns array of character ranges. + </description> + </method> + <method name="_shaped_text_hit_test_grapheme" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="coord" type="float" /> + <description> + Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. + </description> + </method> + <method name="_shaped_text_hit_test_position" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="coord" type="float" /> + <description> + Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. + </description> + </method> + <method name="_shaped_text_is_ready" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if buffer is successfully shaped. + </description> + </method> + <method name="_shaped_text_next_grapheme_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character end position closest to the [code]pos[/code]. + </description> + </method> + <method name="_shaped_text_overrun_trim_to_width" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="trim_flags" type="int" /> + <description> + Trims text if it exceeds the given width. + </description> + </method> + <method name="_shaped_text_prev_grapheme_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character start position closest to the [code]pos[/code]. + </description> + </method> + <method name="_shaped_text_resize_object" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <argument index="2" name="size" type="Vector2" /> + <argument index="3" name="inline_align" type="int" enum="InlineAlign" /> + <description> + Sets new size and alignment of embedded object. + </description> + </method> + <method name="_shaped_text_set_bidi_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="override" type="Array" /> + <description> + Overrides BiDi for the structured text. + 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" /> + <argument index="1" name="direction" type="int" enum="TextServer.Direction" /> + <description> + Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. + [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + </description> + </method> + <method name="_shaped_text_set_orientation" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <description> + Sets desired text orientation. + [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + </description> + </method> + <method name="_shaped_text_set_preserve_control" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="enabled" type="bool" /> + <description> + If set to [code]true[/code] text buffer will display control characters. + </description> + </method> + <method name="_shaped_text_set_preserve_invalid" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="enabled" type="bool" /> + <description> + If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. + </description> + </method> + <method name="_shaped_text_shape" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. + [b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. + </description> + </method> + <method name="_shaped_text_sort_logical" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Copies text glyphs in the logical order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + </description> + </method> + <method name="_shaped_text_substr" qualifiers="virtual const"> + <return type="RID" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="length" type="int" /> + <description> + Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). + </description> + </method> + <method name="_shaped_text_tab_align" qualifiers="virtual"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="tab_stops" type="PackedFloat32Array" /> + <description> + Aligns shaped text to the given tab-stops. + </description> + </method> + <method name="_shaped_text_update_breaks" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Updates line and word breaks. + </description> + </method> + <method name="_shaped_text_update_justification_ops" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Updates justification opportunities (spaces, kashidas, etc.). + </description> + </method> + <method name="_tag_to_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="tag" type="int" /> + <description> + Converts OpenType tag to readable feature, variation, script or language name. + </description> + </method> + </methods> +</class> diff --git a/doc/classes/TextServerManager.xml b/doc/classes/TextServerManager.xml index 0e7b6d15d3..d6a1cde945 100644 --- a/doc/classes/TextServerManager.xml +++ b/doc/classes/TextServerManager.xml @@ -5,11 +5,18 @@ </brief_description> <description> [TextServerManager] is the API backend for loading, enumeration and switching [TextServer]s. - Note: Switching text server at runtime is possible, but will invalidate all fonts and text buffers. Make sure to unload all controls, fonts, and themes before doing so. + [b]Note:[/b] Switching text server at runtime is possible, but will invalidate all fonts and text buffers. Make sure to unload all controls, fonts, and themes before doing so. </description> <tutorials> </tutorials> <methods> + <method name="add_interface"> + <return type="void" /> + <argument index="0" name="interface" type="TextServer" /> + <description> + Registers an [TextServer] interface. + </description> + </method> <method name="find_interface" qualifiers="const"> <return type="TextServer" /> <argument index="0" name="name" type="String" /> @@ -19,7 +26,7 @@ </method> <method name="get_interface" qualifiers="const"> <return type="TextServer" /> - <argument index="0" name="index" type="int" /> + <argument index="0" name="idx" type="int" /> <description> Returns the interface registered at a given index. </description> @@ -30,20 +37,6 @@ Returns the number of interfaces currently registered. </description> </method> - <method name="get_interface_features" qualifiers="const"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - Returns text server supported features (binary OR). - </description> - </method> - <method name="get_interface_name" qualifiers="const"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - Returns the interface name registered at a given index. - </description> - </method> <method name="get_interfaces" qualifiers="const"> <return type="Array" /> <description> @@ -53,15 +46,36 @@ <method name="get_primary_interface" qualifiers="const"> <return type="TextServer" /> <description> - Returns the primary [TextServer] interface. + Returns the primary [TextServer] interface currently in use. + </description> + </method> + <method name="remove_interface"> + <return type="void" /> + <argument index="0" name="interface" type="TextServer" /> + <description> + Removes interface. All fonts and shaped text caches should be freed before removing interface. </description> </method> <method name="set_primary_interface"> - <return type="bool" /> - <argument index="0" name="index" type="int" /> + <return type="void" /> + <argument index="0" name="index" type="TextServer" /> <description> - Sets (and initializes it if required) interface registered at a given index as the primary. Invalidates all references to the fonts and text buffers. + Sets the primary [TextServer] interface. </description> </method> </methods> + <signals> + <signal name="interface_added"> + <argument index="0" name="interface_name" type="StringName" /> + <description> + Emitted when a new interface has been added. + </description> + </signal> + <signal name="interface_removed"> + <argument index="0" name="interface_name" type="StringName" /> + <description> + Emitted when an interface is removed. + </description> + </signal> + </signals> </class> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index edf5874432..d1a48fda55 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -8,7 +8,7 @@ Theme resources can alternatively be loaded by writing them in a [code].theme[/code] file, see the documentation for more information. </description> <tutorials> - <link title="GUI skinning">https://docs.godotengine.org/en/latest/tutorials/gui/gui_skinning.html</link> + <link title="GUI skinning">$DOCS_URL/tutorials/ui/gui_skinning.html</link> </tutorials> <methods> <method name="clear"> @@ -273,6 +273,24 @@ Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. </description> </method> + <method name="has_default_base_scale" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_base_scale] value. + </description> + </method> + <method name="has_default_font" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_font] value. + </description> + </method> + <method name="has_default_font_size" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_font_size] value. + </description> + </method> <method name="has_font" qualifiers="const"> <return type="bool" /> <argument index="0" name="name" type="StringName" /> @@ -479,16 +497,22 @@ Marks [code]theme_type[/code] as being a variation of [code]base_type[/code]. This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class. Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching a class of a [Control], the whole chain is going to be suggested as options. - Note: Suggestions only show up if this [Theme] is set as the project default theme. See [member ProjectSettings.gui/theme/custom]. + [b]Note:[/b] Suggestions only show up if this [Theme] is set as the project default theme. See [member ProjectSettings.gui/theme/custom]. </description> </method> </methods> <members> + <member name="default_base_scale" type="float" setter="set_default_base_scale" getter="get_default_base_scale" default="0.0"> + The default base scale factor of this [Theme] resource. Used by some controls to scale their visual properties based on a global scale factor. If this value is set to [code]0.0[/code], the global scale factor is used. + Use [method has_default_base_scale] to check if this value is valid. + </member> <member name="default_font" type="Font" setter="set_default_font" getter="get_default_font"> - The theme's default font. + The default font of this [Theme] resource. Used as a fallback value for font items defined in this theme, but having invalid values. If this value is also invalid, the global default value is used. + Use [method has_default_font] to check if this value is valid. </member> <member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1"> - The theme's default font size. Set to [code]-1[/code] to ignore and use global default. + The default font size of this [Theme] resource. Used as a fallback value for font size items defined in this theme, but having invalid values. If this value is set to [code]-1[/code], the global default value is used. + Use [method has_default_font_size] to check if this value is valid. </member> </members> <constants> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index ae5c0761b1..bd9a6c865a 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -8,8 +8,8 @@ [b]Note:[/b] Breakpoints won't break on code if it's running in a thread. This is a current limitation of the GDScript debugger. </description> <tutorials> - <link title="Using multiple threads">https://docs.godotengine.org/en/latest/tutorials/threads/using_multiple_threads.html</link> - <link title="Thread-safe APIs">https://docs.godotengine.org/en/latest/tutorials/threads/thread_safe_apis.html</link> + <link title="Using multiple threads">$DOCS_URL/tutorials/performance/using_multiple_threads.html</link> + <link title="Thread-safe APIs">$DOCS_URL/tutorials/performance/thread_safe_apis.html</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <methods> @@ -19,10 +19,17 @@ Returns the current [Thread]'s ID, uniquely identifying it among all threads. If the [Thread] is not running this returns an empty string. </description> </method> - <method name="is_active" qualifiers="const"> + <method name="is_alive" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. + Returns [code]true[/code] if this [Thread] is currently running. This is useful for determining if [method wait_to_finish] can be called without blocking the calling thread. + To check if a [Thread] is joinable, use [method is_started]. + </description> + </method> + <method name="is_started" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this [Thread] has been started. Once started, this will return [code]true[/code] until it is joined using [method wait_to_finish]. For checking if a [Thread] is still executing its task, use [method is_alive]. </description> </method> <method name="start"> @@ -31,15 +38,16 @@ <argument index="1" name="userdata" type="Variant" default="null" /> <argument index="2" name="priority" type="int" enum="Thread.Priority" default="1" /> <description> - Starts a new [Thread] that calls [code]callable[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. + Starts a new [Thread] that calls [code]callable[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]callable[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure. </description> </method> <method name="wait_to_finish"> <return type="Variant" /> <description> - Joins the [Thread] and waits for it to finish. Returns what the method called returned. + Joins the [Thread] and waits for it to finish. Returns the output of the [Callable] passed to [method start]. Should either be used when you want to retrieve the value returned from the method called by the [Thread] or before freeing the instance that contains the [Thread]. + To determine if this can be called without blocking the calling thread, check if [method is_alive] is [code]false[/code]. [b]Note:[/b] After the [Thread] finishes joining it will be disposed. If you want to use it again you will have to create a new instance of it. </description> </method> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index e5fe823be6..6e552e3649 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -7,7 +7,7 @@ Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other. </description> <tutorials> - <link title="Using Tilemaps">https://docs.godotengine.org/en/latest/tutorials/2d/using_tilemaps.html</link> + <link title="Using Tilemaps">$DOCS_URL/tutorials/2d/using_tilemaps.html</link> <link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link> <link title="2D Isometric Demo">https://godotengine.org/asset-library/asset/112</link> <link title="2D Hexagonal Demo">https://godotengine.org/asset-library/asset/111</link> @@ -16,6 +16,27 @@ <link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link> </tutorials> <methods> + <method name="_tile_data_runtime_update" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <argument index="2" name="tile_data" type="TileData" /> + <description> + Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime. + This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [code]coords[/coords] and [code]layer[/code]. + [b]Warning:[/b] The [code]tile_data[/code] object's sub-resources are the same as the one in the TileSet. Modifying them might impact the whole TileSet. Instead, make sure to duplicate those resources. + [b]Note:[/b] If the properties of [code]tile_data[/code] object should change over time, use [method force_update] to trigger a TileMap update. + </description> + </method> + <method name="_use_tile_data_runtime_update" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords" type="Vector2i" /> + <description> + Should return [code]true[/code] if the tile at coordinates [code]coords[/coords] on layer [code]layer[/code] requires a runtime update. + [b]Warning:[/b] Make sure this function only return [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty. + </description> + </method> <method name="add_layer"> <return type="void" /> <argument index="0" name="to_position" type="int" /> @@ -42,6 +63,15 @@ Clears cells that do not exist in the tileset. </description> </method> + <method name="force_update"> + <return type="void" /> + <argument index="0" name="layer" type="int" default="-1" /> + <description> + Triggers an update of the TileMap. If [code]layer[/code] is provided, only updates the given layer. + [b]Note:[/b] The TileMap node updates automatically when one of its properties is modified. A manual update is only needed if runtime modifications (implemented in [method _tile_data_runtime_update]) need to be applied. + [b]Warning:[/b] Updating the TileMap is a performance demanding task. Limit occurences of those updates to the minimum and limit the amount tiles they impact (by segregating tiles updated often to a dedicated layer for example). + </description> + </method> <method name="get_cell_alternative_tile" qualifiers="const"> <return type="int" /> <argument index="0" name="layer" type="int" /> @@ -73,7 +103,14 @@ <return type="Vector2i" /> <argument index="0" name="body" type="RID" /> <description> - Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [member KinematicCollision2D.collider_rid], when colliding with a tile. + Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile. + </description> + </method> + <method name="get_layer_modulate" qualifiers="const"> + <return type="Color" /> + <argument index="0" name="layer" type="int" /> + <description> + Returns a TileMap layer's modulate. </description> </method> <method name="get_layer_name" qualifiers="const"> @@ -110,6 +147,14 @@ Returns the neighboring cell to the one at coordinates [code]coords[/code], indentified by the [code]neighbor[/code] direction. This method takes into account the different layouts a TileMap can take. </description> </method> + <method name="get_pattern"> + <return type="TileMapPattern" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="coords_array" type="Vector2i[]" /> + <description> + Creates a new [TileMapPattern] from the given layer and set of cells. + </description> + </method> <method name="get_surrounding_tiles"> <return type="Vector2i[]" /> <argument index="0" name="coords" type="Vector2i" /> @@ -144,6 +189,15 @@ Returns if a layer Y-sorts its tiles. </description> </method> + <method name="map_pattern"> + <return type="Vector2i" /> + <argument index="0" name="position_in_tilemap" type="Vector2i" /> + <argument index="1" name="coords_in_pattern" type="Vector2i" /> + <argument index="2" name="pattern" type="TileMapPattern" /> + <description> + Returns for the given coodinate [code]coords_in_pattern[/code] in a [TileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [code]position_in_tilemap[/code] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code] + </description> + </method> <method name="map_to_world" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="map_position" type="Vector2i" /> @@ -180,6 +234,17 @@ - The alternative tile identifier [code]alternative_tile[/code] identifies a tile alternative the source is a [TileSetAtlasSource], and the scene for a [TileSetScenesCollectionSource]. </description> </method> + <method name="set_cells_from_surrounding_terrains"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="cells" type="Vector2i[]" /> + <argument index="2" name="terrain_set" type="int" /> + <argument index="3" name="ignore_empty_terrains" type="bool" default="true" /> + <description> + Updates all the cells in the [code]cells[/code] coordinates array and replace them by tiles that matches the surrounding cells terrains. Only cells form the given [code]terrain_set[/code] are considered. + If [code]ignore_empty_terrains[/code] is true, zones with no terrain defined are ignored to select the tiles. + </description> + </method> <method name="set_layer_enabled"> <return type="void" /> <argument index="0" name="layer" type="int" /> @@ -188,6 +253,14 @@ Enables or disables the layer [code]layer[/code]. A disabled layer is not processed at all (no rendering, no physics, etc...). </description> </method> + <method name="set_layer_modulate"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="enabled" type="Color" /> + <description> + Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. + </description> + </method> <method name="set_layer_name"> <return type="void" /> <argument index="0" name="layer" type="int" /> @@ -222,6 +295,15 @@ Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. </description> </method> + <method name="set_pattern"> + <return type="void" /> + <argument index="0" name="layer" type="int" /> + <argument index="1" name="position" type="Vector2i" /> + <argument index="2" name="pattern" type="TileMapPattern" /> + <description> + Paste the given [TileMapPattern] at the given [code]position[/code] and [code]layer[/code] in the tile map. + </description> + </method> <method name="world_to_map" qualifiers="const"> <return type="Vector2i" /> <argument index="0" name="world_position" type="Vector2" /> diff --git a/doc/classes/TileMapPattern.xml b/doc/classes/TileMapPattern.xml new file mode 100644 index 0000000000..ab7c95bb7b --- /dev/null +++ b/doc/classes/TileMapPattern.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TileMapPattern" inherits="Resource" version="4.0"> + <brief_description> + Holds a pattern to be copied from or pasted into [TileMap]s. + </brief_description> + <description> + This resource holds a set of cells to help bulk manipulations of [TileMap]. + A pattern always start at the [code](0,0)[/code] coordinates and cannot have cells with negative coordinates. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_cell_alternative_tile" qualifiers="const"> + <return type="int" /> + <argument index="0" name="coords" type="Vector2i" /> + <description> + Returns the tile alternative ID of the cell at [code]coords[/code]. + </description> + </method> + <method name="get_cell_atlas_coords" qualifiers="const"> + <return type="Vector2i" /> + <argument index="0" name="coords" type="Vector2i" /> + <description> + Returns the tile atlas coordinates ID of the cell at [code]coords[/code]. + </description> + </method> + <method name="get_cell_source_id" qualifiers="const"> + <return type="int" /> + <argument index="0" name="coords" type="Vector2i" /> + <description> + Returns the tile source ID of the cell at [code]coords[/code]. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2i" /> + <description> + Returns the size, in cells, of the pattern. + </description> + </method> + <method name="get_used_cells" qualifiers="const"> + <return type="Vector2i[]" /> + <description> + Returns the list of used cell coordinates in the pattern. + </description> + </method> + <method name="has_cell" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="coords" type="Vector2i" /> + <description> + Returns whether the pattern has a tile at the given coordinates. + </description> + </method> + <method name="is_empty" qualifiers="const"> + <return type="bool" /> + <description> + Returns whether the pattern is empty or not. + </description> + </method> + <method name="remove_cell"> + <return type="void" /> + <argument index="0" name="coords" type="Vector2i" /> + <argument index="1" name="update_size" type="bool" /> + <description> + Remove the cell at the given coordinates. + </description> + </method> + <method name="set_cell"> + <return type="void" /> + <argument index="0" name="coords" type="Vector2i" /> + <argument index="1" name="source_id" type="int" default="-1" /> + <argument index="2" name="atlas_coords" type="Vector2i" default="Vector2i(-1, -1)" /> + <argument index="3" name="alternative_tile" type="int" default="-1" /> + <description> + Sets the tile indentifiers for the cell at coordinates [code]coords[/code]. See [method TileMap.set_cell]. + </description> + </method> + <method name="set_size"> + <return type="void" /> + <argument index="0" name="size" type="Vector2i" /> + <description> + Sets the size of the pattern. + </description> + </method> + </methods> +</class> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 02baded019..5d9065f823 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -13,7 +13,7 @@ See the functions to add new layers for more information. </description> <tutorials> - <link title="Using Tilemaps">https://docs.godotengine.org/en/latest/tutorials/2d/using_tilemaps.html</link> + <link title="Using Tilemaps">$DOCS_URL/tutorials/2d/using_tilemaps.html</link> <link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link> <link title="2D Isometric Demo">https://godotengine.org/asset-library/asset/112</link> <link title="2D Hexagonal Demo">https://godotengine.org/asset-library/asset/111</link> @@ -46,6 +46,14 @@ Occlusion layers allow assigning occlusion polygons to atlas tiles. </description> </method> + <method name="add_pattern"> + <return type="int" /> + <argument index="0" name="pattern" type="TileMapPattern" /> + <argument index="1" name="index" type="int" default="-1" /> + <description> + Adds a [TileMapPattern] to be stored in the TileSet resouce. If provided, insert it at the given [code]index[/code]. + </description> + </method> <method name="add_physics_layer"> <return type="void" /> <argument index="0" name="to_position" type="int" default="-1" /> @@ -154,6 +162,19 @@ Returns the occlusion layers count. </description> </method> + <method name="get_pattern"> + <return type="TileMapPattern" /> + <argument index="0" name="index" type="int" default="-1" /> + <description> + Returns the [TileMapPattern] at the given [code]index[/code]. + </description> + </method> + <method name="get_patterns_count"> + <return type="int" /> + <description> + Returns the number of [TileMapPattern] this tile set handles. + </description> + </method> <method name="get_physics_layer_collision_layer" qualifiers="const"> <return type="int" /> <argument index="0" name="layer_index" type="int" /> @@ -374,6 +395,13 @@ Removes the occlusion layer at index [code]layer_index[/code]. Also updates the atlas tiles accordingly. </description> </method> + <method name="remove_pattern"> + <return type="void" /> + <argument index="0" name="index" type="int" /> + <description> + Remove the [TileMapPattern] at the given index. + </description> + </method> <method name="remove_physics_layer"> <return type="void" /> <argument index="0" name="layer_index" type="int" /> diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml index d12ac840f4..6580c6bd4c 100644 --- a/doc/classes/TileSetAtlasSource.xml +++ b/doc/classes/TileSetAtlasSource.xml @@ -15,12 +15,6 @@ <tutorials> </tutorials> <methods> - <method name="clear_tiles_outside_texture"> - <return type="void" /> - <description> - Clears all tiles that are defined outside the texture boundaries. - </description> - </method> <method name="create_alternative_tile"> <return type="int" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -51,6 +45,21 @@ Returns the alternative ID a following call to [method create_alternative_tile] would return. </description> </method> + <method name="get_runtime_texture" qualifiers="const"> + <return type="Texture2D" /> + <description> + If [member use_texture_padding] is [code]false[/code], returns [member texture]. Otherwise, returns and internal [ImageTexture] created that includes the padding. + </description> + </method> + <method name="get_runtime_tile_texture_region" qualifiers="const"> + <return type="Rect2i" /> + <argument index="0" name="atlas_coords" type="Vector2i" /> + <argument index="1" name="frame" type="int" /> + <description> + Returns the region of the tile at coordinates [code]atlas_coords[/code] for frame [code]frame[/code] inside the texture returned by [method get_runtime_texture]. + [b]Note:[/b] If [member use_texture_padding] is [code]false[/code], returns the same as [method get_tile_texture_region]. + </description> + </method> <method name="get_tile_animation_columns" qualifiers="const"> <return type="int" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -124,6 +133,16 @@ Returns a tile's texture region in the atlas texture. For animated tiles, a [code]frame[/code] argument might be provided for the different frames of the animation. </description> </method> + <method name="get_tiles_to_be_removed_on_change"> + <return type="PackedVector2Array" /> + <argument index="0" name="texture" type="Texture2D" /> + <argument index="1" name="margins" type="Vector2i" /> + <argument index="2" name="separation" type="Vector2i" /> + <argument index="3" name="texture_region_size" type="Vector2i" /> + <description> + Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [code]texture[/code], [code]margins[/code], [code]separation[/code] or [code]texture_region_size[/code]. This can be used to undo changes that would have caused tiles data loss. + </description> + </method> <method name="has_room_for_tile" qualifiers="const"> <return type="bool" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -136,12 +155,6 @@ Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [code]ignored_tile[/code] is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. </description> </method> - <method name="has_tiles_outside_texture"> - <return type="bool" /> - <description> - Returns if this atlas has tiles outside of its texture. - </description> - </method> <method name="move_tile_in_atlas"> <return type="void" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -234,5 +247,9 @@ <member name="texture_region_size" type="Vector2i" setter="set_texture_region_size" getter="get_texture_region_size" default="Vector2i(16, 16)"> The base tile size in the texture (in pixel). This size must be bigger than the TileSet's [code]tile_size[/code] value. </member> + <member name="use_texture_padding" type="bool" setter="set_use_texture_padding" getter="get_use_texture_padding" default="true"> + If [code]true[/code], generates an internal texture with an additional one pixel padding around each tile. Texture padding avoids a common artifact where lines appear between tiles. + Disabling this setting might lead a small performance improvement, as generating the internal texture requires both memory and processing time when the TileSetAtlasSource resource is modified. + </member> </members> </class> diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml index 24ce30154d..b66ec83eaf 100644 --- a/doc/classes/Time.xml +++ b/doc/classes/Time.xml @@ -7,6 +7,7 @@ The Time singleton allows converting time between various formats and also getting time information from the system. This class conforms with as many of the ISO 8601 standards as possible. All dates follow the Proleptic Gregorian calendar. As such, the day before [code]1582-10-15[/code] is [code]1582-10-14[/code], not [code]1582-10-04[/code]. The year before 1 AD (aka 1 BC) is number [code]0[/code], with the year before that (2 BC) being [code]-1[/code], etc. Conversion methods assume "the same timezone", and do not handle timezone conversions or DST automatically. Leap seconds are also not handled, they must be done manually if desired. Suffixes such as "Z" are not handled, you need to strip them away manually. + When getting time information from the system, the time can either be in the local timezone or UTC depending on the [code]utc[/code] parameter. However, the [method get_unix_time_from_system] method always returns the time in UTC. [b]Important:[/b] The [code]_from_system[/code] methods use the system clock that the user can manually set. [b]Never use[/b] this method for precise time calculation since its results are subject to automatic adjustments by the user or the operating system. [b]Always use[/b] [method get_ticks_usec] or [method get_ticks_msec] for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). </description> <tutorials> @@ -82,7 +83,7 @@ <argument index="0" name="utc" type="bool" default="false" /> <argument index="1" name="use_space" type="bool" default="false" /> <description> - Returns the current date and time as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time), [code]hour[/code], [code]minute[/code], and [code]second[/code]. + Returns the current date and time as an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. If [code]use_space[/code] is true, use a space instead of the letter T in the middle. </description> @@ -100,12 +101,14 @@ <return type="int" /> <description> Returns the amount of time passed in milliseconds since the engine started. + Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly 500 million years). </description> </method> <method name="get_ticks_usec" qualifiers="const"> <return type="int" /> <description> Returns the amount of time passed in microseconds since the engine started. + Will always be positive or 0 and uses a 64-bit value (it will wrap after roughly half a million years). </description> </method> <method name="get_time_dict_from_system" qualifiers="const"> @@ -152,6 +155,7 @@ The given dictionary can be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. Any other entries (including [code]dst[/code]) are ignored. If the dictionary is empty, [code]0[/code] is returned. If some keys are omitted, they default to the equivalent values for the Unix epoch timestamp 0 (1970-01-01 at 00:00:00). You can pass the output from [method get_datetime_dict_from_unix_time] directly into this function and get the same as what was put in. + [b]Note:[/b] Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime dictionary. </description> </method> <method name="get_unix_time_from_datetime_string" qualifiers="const"> @@ -159,12 +163,13 @@ <argument index="0" name="datetime" type="String" /> <description> Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. + [b]Note:[/b] Unix timestamps are often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime string. </description> </method> <method name="get_unix_time_from_system" qualifiers="const"> <return type="float" /> <description> - Returns the current Unix timestamp in seconds based on the system time. + Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. </description> </method> </methods> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index b91f159160..f360099f2b 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -22,7 +22,7 @@ <argument index="0" name="time_sec" type="float" default="-1" /> <description> Starts the timer. Sets [code]wait_time[/code] to [code]time_sec[/code] if [code]time_sec > 0[/code]. This also resets the remaining time to [code]wait_time[/code]. - [b]Note:[/b] this method will not resume a paused timer. See [member paused]. + [b]Note:[/b] This method will not resume a paused timer. See [member paused]. </description> </method> <method name="stop"> @@ -51,7 +51,8 @@ [b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [method start]. </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" default="1.0"> - Wait time in seconds. + The wait time in seconds. + [b]Note:[/b] Timers can only emit once per rendered frame at most (or once per physics frame if [member process_callback] is [constant TIMER_PROCESS_PHYSICS]). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. </member> </members> <signals> diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index e75a41a936..f1becb6906 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -30,7 +30,7 @@ </member> <member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled" default="false"> If [code]true[/code], the [signal pressed] and [signal released] signals are emitted whenever a pressed finger goes in and out of the button, even if the pressure started outside the active area of the button. - [b]Note:[/b] this is a "pass-by" (not "bypass") press mode. + [b]Note:[/b] This is a "pass-by" (not "bypass") press mode. </member> <member name="pressed" type="Texture2D" setter="set_texture_pressed" getter="get_texture_pressed"> The button's texture for the pressed state. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 4fd788467d..97cbf6918d 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -8,34 +8,34 @@ For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Matrices and transforms">https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.html</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Transform2D" qualifiers="constructor"> + <constructors> + <constructor name="Transform2D"> <return type="Transform2D" /> <description> Constructs a default-initialized [Transform2D] set to [constant IDENTITY]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="from" type="Transform2D" /> <description> Constructs a [Transform2D] as a copy of the given [Transform2D]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="rotation" type="float" /> <argument index="1" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="rotation" type="float" /> <argument index="1" name="scale" type="Vector2" /> @@ -44,8 +44,8 @@ <description> Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> <argument index="0" name="x_axis" type="Vector2" /> <argument index="1" name="y_axis" type="Vector2" /> @@ -53,7 +53,9 @@ <description> Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). </description> - </method> + </constructor> + </constructors> + <methods> <method name="affine_inverse" qualifiers="const"> <return type="Transform2D" /> <description> @@ -129,72 +131,6 @@ Operations take place in global space. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Rect2" /> - <argument index="0" name="right" type="Rect2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Transform2D" /> <description> @@ -267,4 +203,81 @@ The [Transform2D] that will flip something along the Y axis. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + Returns [code]true[/code] if the transforms are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector2Array" /> + <argument index="0" name="right" type="PackedVector2Array" /> + <description> + Transforms (multiplies) each element of the [Vector2] array by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Rect2" /> + <argument index="0" name="right" type="Rect2" /> + <description> + Transforms (multiplies) the [Rect2] by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Transforms (multiplies) the [Vector2] by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + Returns [code]true[/code] if the transforms are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator []"> + <return type="Vector2" /> + <argument index="0" name="index" type="int" /> + <description> + Access transform components using their index. [code]t[0][/code] is equivalent to [code]t.x[/code], [code]t[1][/code] is equivalent to [code]t.y[/code], and [code]t[2][/code] is equivalent to [code]t.origin[/code]. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 337e7d2693..e62cb9216e 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -8,36 +8,36 @@ For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Matrices and transforms">https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link> - <link title="Using 3D transforms">https://docs.godotengine.org/en/latest/tutorials/3d/using_transforms.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.html</link> + <link title="Using 3D transforms">$DOCS_URL/tutorials/3d/using_transforms.html</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Transform3D" qualifiers="constructor"> + <constructors> + <constructor name="Transform3D"> <return type="Transform3D" /> <description> Constructs a default-initialized [Transform3D] set to [constant IDENTITY]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="from" type="Transform3D" /> <description> Constructs a [Transform3D] as a copy of the given [Transform3D]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="basis" type="Basis" /> <argument index="1" name="origin" type="Vector3" /> <description> Constructs a Transform3D from a [Basis] and [Vector3]. </description> - </method> - <method name="Transform3D" qualifiers="constructor"> + </constructor> + <constructor name="Transform3D"> <return type="Transform3D" /> <argument index="0" name="x_axis" type="Vector3" /> <argument index="1" name="y_axis" type="Vector3" /> @@ -46,7 +46,9 @@ <description> Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). </description> - </method> + </constructor> + </constructors> + <methods> <method name="affine_inverse" qualifiers="const"> <return type="Transform3D" /> <description> @@ -83,66 +85,6 @@ The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector3Array" /> - <argument index="0" name="right" type="PackedVector3Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="AABB" /> - <argument index="0" name="right" type="AABB" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="float" /> - <description> - This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform3D" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> <method name="orthonormalized" qualifiers="const"> <return type="Transform3D" /> <description> @@ -195,4 +137,74 @@ [Transform3D] with mirroring applied perpendicular to the XY plane. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + Returns [code]true[/code] if the transforms are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="AABB" /> + <argument index="0" name="right" type="AABB" /> + <description> + Transforms (multiplies) the [AABB] by the given [Transform3D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector3Array" /> + <argument index="0" name="right" type="PackedVector3Array" /> + <description> + Transforms (multiplies) each element of the [Vector3] array by the given [Transform3D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Transform3D" /> + <argument index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + Returns [code]true[/code] if the transforms are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index 2a0695d42e..defebf7ab4 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -7,8 +7,8 @@ Translations are resources that can be loaded and unloaded on demand. They map a string to another string. </description> <tutorials> - <link title="Internationalizing games">https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link> - <link title="Locales">https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link> + <link title="Internationalizing games">$DOCS_URL/tutorials/i18n/internationalizing_games.html</link> + <link title="Locales">$DOCS_URL/tutorials/i18n/locales.html</link> </tutorials> <methods> <method name="_get_message" qualifiers="virtual const"> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index 8a6fa3571a..a1b4404079 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -7,8 +7,8 @@ Server that manages all translations. Translations can be set to it and removed from it. </description> <tutorials> - <link title="Internationalizing games">https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html</link> - <link title="Locales">https://docs.godotengine.org/en/latest/tutorials/i18n/locales.html</link> + <link title="Internationalizing games">$DOCS_URL/tutorials/i18n/internationalizing_games.html</link> + <link title="Locales">$DOCS_URL/tutorials/i18n/locales.html</link> </tutorials> <methods> <method name="add_translation"> @@ -49,7 +49,7 @@ <argument index="0" name="locale" type="String" /> <description> Returns the [Translation] instance based on the [code]locale[/code] passed in. - It will return a [code]nullptr[/code] if there is no [Translation] instance that matches the [code]locale[/code]. + It will return [code]null[/code] if there is no [Translation] instance that matches the [code]locale[/code]. </description> </method> <method name="pseudolocalize" qualifiers="const"> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index f94018c96b..05c83f0423 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -74,17 +74,17 @@ </method> <method name="interpolate_value"> <return type="Variant" /> - <argument index="0" name="trans_type" type="Variant" /> - <argument index="1" name="ease_type" type="Variant" /> + <argument index="0" name="initial_value" type="Variant" /> + <argument index="1" name="delta_value" type="Variant" /> <argument index="2" name="elapsed_time" type="float" /> - <argument index="3" name="initial_value" type="float" /> - <argument index="4" name="delta_value" type="int" enum="Tween.TransitionType" /> - <argument index="5" name="duration" type="int" enum="Tween.EaseType" /> + <argument index="3" name="duration" type="float" /> + <argument index="4" name="trans_type" type="int" enum="Tween.TransitionType" /> + <argument index="5" name="ease_type" type="int" enum="Tween.EaseType" /> <description> This method can be used for manual interpolation of a value, when you don't want [Tween] to do animating for you. It's similar to [method @GlobalScope.lerp], but with support for custom transition and easing. - [code]elapsed_time[/code] is the time in seconds that passed after the interping started and it's used to control the position of the interpolation. E.g. when it's equal to half of the [code]duration[/code], the interpolated value will be halfway between initial and final values. This value can also be greater than [code]duration[/code] or lower than 0, which will extrapolate the value. [code]initial_value[/code] is the starting value of the interpolation. [code]delta_value[/code] is the change of the value in the interpolation, i.e. it's equal to [code]final_value - initial_value[/code]. + [code]elapsed_time[/code] is the time in seconds that passed after the interpolation started and it's used to control the position of the interpolation. E.g. when it's equal to half of the [code]duration[/code], the interpolated value will be halfway between initial and final values. This value can also be greater than [code]duration[/code] or lower than 0, which will extrapolate the value. [code]duration[/code] is the total time of the interpolation. [b]Note:[/b] If [code]duration[/code] is equal to [code]0[/code], the method will always return the final value, regardless of [code]elapsed_time[/code] provided. </description> @@ -146,6 +146,7 @@ <description> Sets the number of times the tweening sequence will be repeated, i.e. [code]set_loops(2)[/code] will run the animation twice. Calling this method without arguments will make the [Tween] run infinitely, until it is either killed by [method kill] or by freeing bound node, or all the animated objects have been freed (which makes further animation impossible). + [b]Warning:[/b] Make sure to always add some duration/delay when using infinite loops. 0-duration looped animations (e.g. single [CallbackTweener] with no delay) are equivalent to infinite [code]while[/code] loops and will freeze your game. </description> </method> <method name="set_parallel"> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index def6fe5d1f..044460f569 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -134,6 +134,12 @@ The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details. </description> </method> + <method name="end_force_keep_in_merge_ends"> + <return type="void" /> + <description> + Stops marking operations as to be processed even if the action gets merged with another in the [constant MERGE_ENDS] mode. See [method start_force_keep_in_merge_ends]. + </description> + </method> <method name="get_action_name"> <return type="String" /> <argument index="0" name="id" type="int" /> @@ -190,6 +196,12 @@ Redo the last action. </description> </method> + <method name="start_force_keep_in_merge_ends"> + <return type="void" /> + <description> + Marks the next "do" and "undo" operations to be processed even if the action gets merged with another in the [constant MERGE_ENDS] mode. Return to normal operation using [method end_force_keep_in_merge_ends]. + </description> + </method> <method name="undo"> <return type="bool" /> <description> @@ -209,7 +221,7 @@ Makes "do"/"undo" operations stay in separate actions. </constant> <constant name="MERGE_ENDS" value="1" enum="MergeMode"> - Makes so that the action's "do" operation is from the first action created and the "undo" operation is from the last subsequent action with the same name. + Makes so that the action's "undo" operations are from the first action created and the "do" operations are from the last subsequent action with the same name. </constant> <constant name="MERGE_ALL" value="2" enum="MergeMode"> Makes subsequent actions with the same name be merged into one. diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index 88644e2f8a..b8649a2836 100644 --- a/doc/classes/Variant.xml +++ b/doc/classes/Variant.xml @@ -72,6 +72,6 @@ Modifications to a container will modify all references to it. A [Mutex] should be created to lock it if multi-threaded access is desired. </description> <tutorials> - <link title="Variant class">https://docs.godotengine.org/en/latest/development/cpp/variant_class.html</link> + <link title="Variant class">$DOCS_URL/development/cpp/variant_class.html</link> </tutorials> </class> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index b61d5bea0e..15f7d2f9e3 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -9,42 +9,44 @@ [b]Note:[/b] In a boolean context, a Vector2 will evaluate to [code]false[/code] if it's equal to [code]Vector2(0, 0)[/code]. Otherwise, a Vector2 will always evaluate to [code]true[/code]. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> - <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> + <link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link> </tutorials> - <methods> - <method name="Vector2" qualifiers="constructor"> + <constructors> + <constructor name="Vector2"> <return type="Vector2" /> <description> Constructs a default-initialized [Vector2] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="from" type="Vector2" /> <description> Constructs a [Vector2] as a copy of the given [Vector2]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="from" type="Vector2i" /> <description> Constructs a new [Vector2] from [Vector2i]. </description> - </method> - <method name="Vector2" qualifiers="constructor"> + </constructor> + <constructor name="Vector2"> <return type="Vector2" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> <description> Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector2" /> <description> @@ -73,6 +75,7 @@ <argument index="0" name="to" type="Vector2" /> <description> Returns the angle between the line connecting the two points and the X axis, in radians. + [code]a.angle_to_point(b)[/code] is equivalent of doing [code](b - a).angle()[/code]. [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/vector2_angle_to_point.png]Illustration of the returned angle.[/url] </description> </method> @@ -122,16 +125,16 @@ </method> <method name="direction_to" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="b" type="Vector2" /> + <argument index="0" name="to" type="Vector2" /> <description> - Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code]. + Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. </description> </method> <method name="distance_squared_to" qualifiers="const"> <return type="float" /> <argument index="0" name="to" type="Vector2" /> <description> - Returns the squared distance between this vector and [code]b[/code]. + Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. </description> </method> @@ -225,122 +228,6 @@ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Vector2" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Vector2" /> - <description> - </description> - </method> <method name="orthogonal" qualifiers="const"> <return type="Vector2" /> <description> @@ -455,4 +342,154 @@ Down unit vector. Y is down in 2D, so this vector points +Y. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Returns [code]true[/code] if the vectors are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Transform2D" /> + <description> + Inversely transforms (multiplies) the [Vector2] by the given [Transform2D] transformation matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Multiplies each component of the [Vector2] by the components of the given [Vector2]. + [codeblock] + print(Vector2(10, 20) * Vector2(3, 4)) # Prints "(30, 80)" + [/codeblock] + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies each component of the [Vector2] by the given [float]. + </description> + </operator> + <operator name="operator *"> + <return type="Vector2" /> + <argument index="0" name="right" type="int" /> + <description> + Multiplies each component of the [Vector2] by the given [int]. + </description> + </operator> + <operator name="operator +"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Adds each component of the [Vector2] by the components of the given [Vector2]. + [codeblock] + print(Vector2(10, 20) + Vector2(3, 4)) # Prints "(13, 24)" + [/codeblock] + </description> + </operator> + <operator name="operator -"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Subtracts each component of the [Vector2] by the components of the given [Vector2]. + [codeblock] + print(Vector2(10, 20) - Vector2(3, 4)) # Prints "(7, 16)" + [/codeblock] + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Divides each component of the [Vector2] by the components of the given [Vector2]. + [codeblock] + print(Vector2(10, 20) / Vector2(2, 5)) # Prints "(5, 4)" + [/codeblock] + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="float" /> + <description> + Divides each component of the [Vector2] by the given [float]. + </description> + </operator> + <operator name="operator /"> + <return type="Vector2" /> + <argument index="0" name="right" type="int" /> + <description> + Divides each component of the [Vector2] by the given [int]. + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Compares two [Vector2] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Compares two [Vector2] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Returns [code]true[/code] if the vectors are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Vector2" /> + <description> + Compares two [Vector2] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. + </description> + </operator> + <operator name="operator unary+"> + <return type="Vector2" /> + <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. + </description> + </operator> + <operator name="operator unary-"> + <return type="Vector2" /> + <description> + Returns the negative value of the [Vector2]. This is the same as writing [code]Vector2(-v.x, -v.y)[/code]. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml index 2e69d6efdf..62362409a5 100644 --- a/doc/classes/Vector2i.xml +++ b/doc/classes/Vector2i.xml @@ -9,39 +9,41 @@ [b]Note:[/b] In a boolean context, a Vector2i will evaluate to [code]false[/code] if it's equal to [code]Vector2i(0, 0)[/code]. Otherwise, a Vector2i will always evaluate to [code]true[/code]. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> </tutorials> - <methods> - <method name="Vector2i" qualifiers="constructor"> + <constructors> + <constructor name="Vector2i"> <return type="Vector2i" /> <description> Constructs a default-initialized [Vector2i] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="from" type="Vector2i" /> <description> Constructs a [Vector2i] as a copy of the given [Vector2i]. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="from" type="Vector2" /> <description> Constructs a new [Vector2i] from [Vector2]. The floating point coordinates will be truncated. </description> - </method> - <method name="Vector2i" qualifiers="constructor"> + </constructor> + <constructor name="Vector2i"> <return type="Vector2i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> <description> Constructs a new [Vector2i] from the given [code]x[/code] and [code]y[/code]. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector2i" /> <description> @@ -62,167 +64,212 @@ Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="sign" qualifiers="const"> + <return type="Vector2i" /> <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="x" type="int" setter="" getter="" default="0"> + The vector's X component. Also accessible by using the index position [code][0][/code]. + </member> + <member name="y" type="int" setter="" getter="" default="0"> + The vector's Y component. Also accessible by using the index position [code][1][/code]. + </member> + </members> + <constants> + <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. + </constant> + <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. + </constant> + <constant name="ZERO" value="Vector2i(0, 0)"> + Zero vector, a vector with all components set to [code]0[/code]. + </constant> + <constant name="ONE" value="Vector2i(1, 1)"> + One vector, a vector with all components set to [code]1[/code]. + </constant> + <constant name="LEFT" value="Vector2i(-1, 0)"> + Left unit vector. Represents the direction of left. + </constant> + <constant name="RIGHT" value="Vector2i(1, 0)"> + Right unit vector. Represents the direction of right. + </constant> + <constant name="UP" value="Vector2i(0, -1)"> + Up unit vector. Y is down in 2D, so this vector points -Y. + </constant> + <constant name="DOWN" value="Vector2i(0, 1)"> + Down unit vector. Y is down in 2D, so this vector points +Y. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Returns [code]true[/code] if the vectors are not equal. </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> + Gets the remainder of each component of the [Vector2i] with the components of the given [Vector2i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector2i(10, -20) % Vector2i(7, 8)) # Prints "(3, -4)" + [/codeblock] </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> + Gets the remainder of each component of the [Vector2i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector2i(10, -20) % 7) # Prints "(3, -6)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> + Multiplies each component of the [Vector2i] by the components of the given [Vector2i]. + [codeblock] + print(Vector2i(10, 20) * Vector2i(3, 4)) # Prints "(30, 80)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="float" /> <description> + Multiplies each component of the [Vector2i] by the given [float] truncated to an integer. + [codeblock] + print(Vector2i(10, 20) * 0.9) # Prints "(0, 0)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> + Multiplies each component of the [Vector2i] by the given [int]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> + Adds each component of the [Vector2i] by the components of the given [Vector2i]. + [codeblock] + print(Vector2i(10, 20) + Vector2i(3, 4)) # Prints "(13, 24)" + [/codeblock] </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> + Subtracts each component of the [Vector2i] by the components of the given [Vector2i]. + [codeblock] + print(Vector2i(10, 20) - Vector2i(3, 4)) # Prints "(7, 16)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> + Divides each component of the [Vector2i] by the components of the given [Vector2i]. + [codeblock] + print(Vector2i(10, 20) / Vector2i(2, 5)) # Prints "(5, 4)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="float" /> <description> + Divides each component of the [Vector2i] by the given [float] truncated to an integer. + [codeblock] + print(Vector2i(10, 20) / 2.9) # Prints "(5, 10)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector2i" /> <argument index="0" name="right" type="int" /> <description> + Divides each component of the [Vector2i] by the given [int]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Compares two [Vector2i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Returns [code]true[/code] if the vectors are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="Vector2i" /> <description> + Compares two [Vector2i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors. </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="int" /> <argument index="0" name="index" type="int" /> <description> + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], and [code]v[1][/code] is equivalent to [code]v.y[/code]. </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="Vector2i" /> <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="Vector2i" /> <description> + Returns the negative value of the [Vector2i]. This is the same as writing [code]Vector2i(-v.x, -v.y)[/code]. This operation flips the direction of the vector while keeping the same magnitude. </description> - </method> - <method name="sign" qualifiers="const"> - <return type="Vector2i" /> - <description> - Returns the vector with each component set to one or negative one, depending on the signs of the components. - </description> - </method> - </methods> - <members> - <member name="x" type="int" setter="" getter="" default="0"> - The vector's X component. Also accessible by using the index position [code][0][/code]. - </member> - <member name="y" type="int" setter="" getter="" default="0"> - The vector's Y component. Also accessible by using the index position [code][1][/code]. - </member> - </members> - <constants> - <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. - </constant> - <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. - </constant> - <constant name="ZERO" value="Vector2i(0, 0)"> - Zero vector, a vector with all components set to [code]0[/code]. - </constant> - <constant name="ONE" value="Vector2i(1, 1)"> - One vector, a vector with all components set to [code]1[/code]. - </constant> - <constant name="LEFT" value="Vector2i(-1, 0)"> - Left unit vector. Represents the direction of left. - </constant> - <constant name="RIGHT" value="Vector2i(1, 0)"> - Right unit vector. Represents the direction of right. - </constant> - <constant name="UP" value="Vector2i(0, -1)"> - Up unit vector. Y is down in 2D, so this vector points -Y. - </constant> - <constant name="DOWN" value="Vector2i(0, 1)"> - Down unit vector. Y is down in 2D, so this vector points +Y. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 9f2ea7b2a0..6d87ce9ea8 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -9,35 +9,35 @@ [b]Note:[/b] In a boolean context, a Vector3 will evaluate to [code]false[/code] if it's equal to [code]Vector3(0, 0, 0)[/code]. Otherwise, a Vector3 will always evaluate to [code]true[/code]. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> - <link title="Advanced vector math">https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> + <link title="Advanced vector math">$DOCS_URL/tutorials/math/vectors_advanced.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link> </tutorials> - <methods> - <method name="Vector3" qualifiers="constructor"> + <constructors> + <constructor name="Vector3"> <return type="Vector3" /> <description> Constructs a default-initialized [Vector3] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="from" type="Vector3" /> <description> Constructs a [Vector3] as a copy of the given [Vector3]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="from" type="Vector3i" /> <description> Constructs a new [Vector3] from [Vector3i]. </description> - </method> - <method name="Vector3" qualifiers="constructor"> + </constructor> + <constructor name="Vector3"> <return type="Vector3" /> <argument index="0" name="x" type="float" /> <argument index="1" name="y" type="float" /> @@ -45,7 +45,9 @@ <description> Returns a [Vector3] with the given components. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector3" /> <description> @@ -84,7 +86,7 @@ <return type="Vector3" /> <argument index="0" name="with" type="Vector3" /> <description> - Returns the cross product of this vector and [code]b[/code]. + Returns the cross product of this vector and [code]with[/code]. </description> </method> <method name="cubic_interpolate" qualifiers="const"> @@ -99,31 +101,31 @@ </method> <method name="direction_to" qualifiers="const"> <return type="Vector3" /> - <argument index="0" name="b" type="Vector3" /> + <argument index="0" name="to" type="Vector3" /> <description> - Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code]. + Returns the normalized vector pointing from this vector to [code]to[/code]. This is equivalent to using [code](b - a).normalized()[/code]. </description> </method> <method name="distance_squared_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="b" type="Vector3" /> + <argument index="0" name="to" type="Vector3" /> <description> - Returns the squared distance between this vector and [code]b[/code]. + Returns the squared distance between this vector and [code]to[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. </description> </method> <method name="distance_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="b" type="Vector3" /> + <argument index="0" name="to" type="Vector3" /> <description> - Returns the distance between this vector and [code]b[/code]. + Returns the distance between this vector and [code]to[/code]. </description> </method> <method name="dot" qualifiers="const"> <return type="float" /> <argument index="0" name="with" type="Vector3" /> <description> - Returns the dot product of this vector and [code]b[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. + Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. When using unit (normalized) vectors, the result will always be between [code]-1.0[/code] (180 degree angle) when the vectors are facing opposite directions, and [code]1.0[/code] (0 degree angle) when the vectors are aligned. [b]Note:[/b] [code]a.dot(b)[/code] is equivalent to [code]b.dot(a)[/code]. @@ -208,131 +210,14 @@ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Basis" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Transform3D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator +" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator -" qualifiers="operator"> + <method name="octahedron_decode" qualifiers="static"> <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="Vector3" /> + <argument index="0" name="uv" type="Vector2" /> <description> </description> </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="float" /> - <description> - </description> - </method> - <method name="operator /" qualifiers="operator"> - <return type="Vector3" /> - <argument index="0" name="right" type="int" /> - <description> - </description> - </method> - <method name="operator <" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator <=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator >" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator >=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Vector3" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="index" type="int" /> - <description> - </description> - </method> - <method name="operator unary+" qualifiers="operator"> - <return type="Vector3" /> - <description> - </description> - </method> - <method name="operator unary-" qualifiers="operator"> - <return type="Vector3" /> + <method name="octahedron_encode" qualifiers="const"> + <return type="Vector2" /> <description> </description> </method> @@ -340,7 +225,7 @@ <return type="Basis" /> <argument index="0" name="with" type="Vector3" /> <description> - Returns the outer product with [code]b[/code]. + Returns the outer product with [code]with[/code]. </description> </method> <method name="posmod" qualifiers="const"> @@ -472,4 +357,168 @@ Back unit vector. Represents the local direction of back, and the global direction of south. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Returns [code]true[/code] if the vectors are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Basis" /> + <description> + Inversely transforms (multiplies) the [Vector3] by the given [Basis] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + Inversely transforms (multiplies) the [Vector3] by the given [Quaternion]. + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Transform3D" /> + <description> + Inversely transforms (multiplies) the [Vector3] by the given [Transform3D] transformation matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Multiplies each component of the [Vector3] by the components of the given [Vector3]. + [codeblock] + print(Vector3(10, 20, 30) * Vector3(3, 4, 5)) # Prints "(30, 80, 150)" + [/codeblock] + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies each component of the [Vector3] by the given [float]. + </description> + </operator> + <operator name="operator *"> + <return type="Vector3" /> + <argument index="0" name="right" type="int" /> + <description> + Multiplies each component of the [Vector3] by the given [int]. + </description> + </operator> + <operator name="operator +"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Adds each component of the [Vector3] by the components of the given [Vector3]. + [codeblock] + print(Vector3(10, 20, 30) + Vector3(3, 4, 5)) # Prints "(13, 24, 35)" + [/codeblock] + </description> + </operator> + <operator name="operator -"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Subtracts each component of the [Vector3] by the components of the given [Vector3]. + [codeblock] + print(Vector3(10, 20, 30) - Vector3(3, 4, 5)) # Prints "(7, 16, 25)" + [/codeblock] + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Divides each component of the [Vector3] by the components of the given [Vector3]. + [codeblock] + print(Vector3(10, 20, 30) / Vector3(2, 5, 3)) # Prints "(5, 4, 10)" + [/codeblock] + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="float" /> + <description> + Divides each component of the [Vector3] by the given [float]. + </description> + </operator> + <operator name="operator /"> + <return type="Vector3" /> + <argument index="0" name="right" type="int" /> + <description> + Divides each component of the [Vector3] by the given [int]. + </description> + </operator> + <operator name="operator <"> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Compares two [Vector3] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator <="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Compares two [Vector3] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Returns [code]true[/code] if the vectors are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. + </description> + </operator> + <operator name="operator >"> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator >="> + <return type="bool" /> + <argument index="0" name="right" type="Vector3" /> + <description> + Compares two [Vector3] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. + </description> + </operator> + <operator name="operator unary+"> + <return type="Vector3" /> + <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. + </description> + </operator> + <operator name="operator unary-"> + <return type="Vector3" /> + <description> + Returns the negative value of the [Vector3]. This is the same as writing [code]Vector3(-v.x, -v.y, -v.z)[/code]. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. + </description> + </operator> + </operators> </class> diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml index bc3712ba3e..17febdea83 100644 --- a/doc/classes/Vector3i.xml +++ b/doc/classes/Vector3i.xml @@ -9,32 +9,32 @@ [b]Note:[/b] In a boolean context, a Vector3i will evaluate to [code]false[/code] if it's equal to [code]Vector3i(0, 0, 0)[/code]. Otherwise, a Vector3i will always evaluate to [code]true[/code]. </description> <tutorials> - <link title="Math tutorial index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Vector math">https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Vector math">$DOCS_URL/tutorials/math/vector_math.html</link> <link title="3Blue1Brown Essence of Linear Algebra">https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link> </tutorials> - <methods> - <method name="Vector3i" qualifiers="constructor"> + <constructors> + <constructor name="Vector3i"> <return type="Vector3i" /> <description> Constructs a default-initialized [Vector3i] with all components set to [code]0[/code]. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="from" type="Vector3i" /> <description> Constructs a [Vector3i] as a copy of the given [Vector3i]. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="from" type="Vector3" /> <description> Constructs a new [Vector3i] from [Vector3]. The floating point coordinates will be truncated. </description> - </method> - <method name="Vector3i" qualifiers="constructor"> + </constructor> + <constructor name="Vector3i"> <return type="Vector3i" /> <argument index="0" name="x" type="int" /> <argument index="1" name="y" type="int" /> @@ -42,7 +42,9 @@ <description> Returns a [Vector3i] with the given components. </description> - </method> + </constructor> + </constructors> + <methods> <method name="abs" qualifiers="const"> <return type="Vector3i" /> <description> @@ -68,179 +70,224 @@ Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z]. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> + <method name="sign" qualifiers="const"> + <return type="Vector3i" /> <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. </description> </method> - <method name="operator !=" qualifiers="operator"> + </methods> + <members> + <member name="x" type="int" setter="" getter="" default="0"> + The vector's X component. Also accessible by using the index position [code][0][/code]. + </member> + <member name="y" type="int" setter="" getter="" default="0"> + The vector's Y component. Also accessible by using the index position [code][1][/code]. + </member> + <member name="z" type="int" setter="" getter="" default="0"> + The vector's Z component. Also accessible by using the index position [code][2][/code]. + </member> + </members> + <constants> + <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. + </constant> + <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. + </constant> + <constant name="AXIS_Z" value="2"> + Enumerated value for the Z axis. + </constant> + <constant name="ZERO" value="Vector3i(0, 0, 0)"> + Zero vector, a vector with all components set to [code]0[/code]. + </constant> + <constant name="ONE" value="Vector3i(1, 1, 1)"> + One vector, a vector with all components set to [code]1[/code]. + </constant> + <constant name="LEFT" value="Vector3i(-1, 0, 0)"> + Left unit vector. Represents the local direction of left, and the global direction of west. + </constant> + <constant name="RIGHT" value="Vector3i(1, 0, 0)"> + Right unit vector. Represents the local direction of right, and the global direction of east. + </constant> + <constant name="UP" value="Vector3i(0, 1, 0)"> + Up unit vector. + </constant> + <constant name="DOWN" value="Vector3i(0, -1, 0)"> + Down unit vector. + </constant> + <constant name="FORWARD" value="Vector3i(0, 0, -1)"> + Forward unit vector. Represents the local direction of forward, and the global direction of north. + </constant> + <constant name="BACK" value="Vector3i(0, 0, 1)"> + Back unit vector. Represents the local direction of back, and the global direction of south. + </constant> + </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Returns [code]true[/code] if the vectors are not equal. </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> + Gets the remainder of each component of the [Vector3i] with the components of the given [Vector3i]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector3i(10, -20, 30) % Vector3i(7, 8, 9)) # Prints "(3, -4, 3)" + [/codeblock] </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> + Gets the remainder of each component of the [Vector3i] with the the given [int]. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. + [codeblock] + print(Vector2i(10, -20, 30) % 7) # Prints "(3, -6, 2)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> + Multiplies each component of the [Vector3i] by the components of the given [Vector3i]. + [codeblock] + print(Vector3i(10, 20, 30) * Vector3i(3, 4, 5)) # Prints "(30, 80, 150)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="float" /> <description> + Multiplies each component of the [Vector3i] by the given [float] truncated to an integer. + [codeblock] + print(Vector3i(10, 20, 30) * 0.9) # Prints "(0, 0, 0)" + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> + Multiplies each component of the [Vector3i] by the given [int]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> + Adds each component of the [Vector3i] by the components of the given [Vector3i]. + [codeblock] + print(Vector3i(10, 20, 30) + Vector3i(3, 4, 5)) # Prints "(13, 24, 35)" + [/codeblock] </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> + Subtracts each component of the [Vector3i] by the components of the given [Vector3i]. + [codeblock] + print(Vector3i(10, 20, 30) - Vector3i(3, 4, 5)) # Prints "(7, 16, 25)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> + Divides each component of the [Vector3i] by the components of the given [Vector3i]. + [codeblock] + print(Vector3i(10, 20, 30) / Vector3i(2, 5, 3)) # Prints "(5, 4, 10)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="float" /> <description> + Divides each component of the [Vector3i] by the given [float] truncated to an integer. + [codeblock] + print(Vector3i(10, 20, 30) / 2.9) # Prints "(5, 10, 15)" + [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="Vector3i" /> <argument index="0" name="right" type="int" /> <description> + Divides each component of the [Vector3i] by the given [int]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Compares two [Vector3i] vectors by first checking if the X value of the left vector is less than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Returns [code]true[/code] if the vectors are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="Vector3i" /> <description> + Compares two [Vector3i] vectors by first checking if the X value of the left vector is greater than or equal to the X value of the [code]right[/code] vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, and then with the Z values. This operator is useful for sorting vectors. </description> - </method> - <method name="operator []" qualifiers="operator"> + </operator> + <operator name="operator []"> <return type="int" /> <argument index="0" name="index" type="int" /> <description> + Access vector components using their index. [code]v[0][/code] is equivalent to [code]v.x[/code], [code]v[1][/code] is equivalent to [code]v.y[/code], and [code]v[2][/code] is equivalent to [code]v.z[/code]. </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="Vector3i" /> <description> + Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="Vector3i" /> <description> + Returns the negative value of the [Vector3i]. This is the same as writing [code]Vector3i(-v.x, -v.y, -v.z)[/code]. This operation flips the direction of the vector while keeping the same magnitude. </description> - </method> - <method name="sign" qualifiers="const"> - <return type="Vector3i" /> - <description> - Returns the vector with each component set to one or negative one, depending on the signs of the components. - </description> - </method> - </methods> - <members> - <member name="x" type="int" setter="" getter="" default="0"> - The vector's X component. Also accessible by using the index position [code][0][/code]. - </member> - <member name="y" type="int" setter="" getter="" default="0"> - The vector's Y component. Also accessible by using the index position [code][1][/code]. - </member> - <member name="z" type="int" setter="" getter="" default="0"> - The vector's Z component. Also accessible by using the index position [code][2][/code]. - </member> - </members> - <constants> - <constant name="AXIS_X" value="0"> - Enumerated value for the X axis. - </constant> - <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. - </constant> - <constant name="AXIS_Z" value="2"> - Enumerated value for the Z axis. - </constant> - <constant name="ZERO" value="Vector3i(0, 0, 0)"> - Zero vector, a vector with all components set to [code]0[/code]. - </constant> - <constant name="ONE" value="Vector3i(1, 1, 1)"> - One vector, a vector with all components set to [code]1[/code]. - </constant> - <constant name="LEFT" value="Vector3i(-1, 0, 0)"> - Left unit vector. Represents the local direction of left, and the global direction of west. - </constant> - <constant name="RIGHT" value="Vector3i(1, 0, 0)"> - Right unit vector. Represents the local direction of right, and the global direction of east. - </constant> - <constant name="UP" value="Vector3i(0, 1, 0)"> - Up unit vector. - </constant> - <constant name="DOWN" value="Vector3i(0, -1, 0)"> - Down unit vector. - </constant> - <constant name="FORWARD" value="Vector3i(0, 0, -1)"> - Forward unit vector. Represents the local direction of forward, and the global direction of north. - </constant> - <constant name="BACK" value="Vector3i(0, 0, 1)"> - Back unit vector. Represents the local direction of back, and the global direction of south. - </constant> - </constants> + </operator> + </operators> </class> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 4f60b9d567..c8590988f5 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -5,9 +5,9 @@ </brief_description> <description> Control node for playing video streams using [VideoStream] resources. - Supported video formats are [url=https://www.webmproject.org/]WebM[/url] ([code].webm[/code], [VideoStreamWebm]), [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]), and any format exposed via a GDNative plugin using [VideoStreamGDNative]. + Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDNative plugin using [VideoStreamGDNative]. [b]Note:[/b] Due to a bug, VideoPlayer does not support localization remapping yet. - [b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations, especially for VP8/VP9. + [b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations. </description> <tutorials> </tutorials> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 06a7177bfc..4a3f99696d 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -12,8 +12,8 @@ Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. </description> <tutorials> - <link title="Viewport and canvas transforms">https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> - <link title="Viewports tutorial index">https://docs.godotengine.org/en/latest/tutorials/viewports/index.html</link> + <link title="Using Viewports">$DOCS_URL/tutorials/rendering/viewports.html</link> + <link title="Viewport and canvas transforms">$DOCS_URL/tutorials/2d/2d_transforms.html</link> <link title="GUI in 3D Demo">https://godotengine.org/asset-library/asset/127</link> <link title="3D in 2D Demo">https://godotengine.org/asset-library/asset/128</link> <link title="2D in 3D Demo">https://godotengine.org/asset-library/asset/129</link> @@ -25,13 +25,13 @@ <method name="find_world_2d" qualifiers="const"> <return type="World2D" /> <description> - Returns the 2D world of the viewport. + Returns the first valid [World2D] for this viewport, searching the [member world_2d] property of itself and any Viewport ancestor. </description> </method> <method name="find_world_3d" qualifiers="const"> <return type="World3D" /> <description> - Returns the 3D world of the viewport, or if none the world of the parent viewport. + Returns the first valid [World3D] for this viewport, searching the [member world_3d] property of itself and any Viewport ancestor. </description> </method> <method name="get_camera_2d" qualifiers="const"> @@ -107,6 +107,12 @@ Returns the drag data from the GUI, that was previously returned by [method Control._get_drag_data]. </description> </method> + <method name="gui_is_drag_successful" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the drag operation is successful. + </description> + </method> <method name="gui_is_dragging" qualifiers="const"> <return type="bool" /> <description> @@ -188,6 +194,14 @@ <member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled" default="false"> Disable 3D rendering (but keep 2D rendering). </member> + <member name="fsr_mipmap_bias" type="float" setter="set_fsr_mipmap_bias" getter="get_fsr_mipmap_bias" default="0.0"> + Affects the final texture sharpness by reading from a lower or higher mipmap when using FSR. Mipmap bias does nothing when FSR is not being used. Negative values make textures sharper, while positive values make textures blurrier. This value is used to adjust the mipmap bias calculated internally which is based on the selected quality. The formula for this is [code]-log2(1.0 / scale) + mipmap_bias[/code]. This updates the rendering server's mipmap bias when called + To control this property on the root viewport, set the [member ProjectSettings.rendering/scaling_3d/fsr_mipmap_bias] project setting. + </member> + <member name="fsr_sharpness" type="float" setter="set_fsr_sharpness" getter="get_fsr_sharpness" default="0.2"> + Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference. + To control this property on the root viewport, set the [member ProjectSettings.rendering/scaling_3d/fsr_sharpness] project setting. + </member> <member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform"> The global canvas transform of the viewport. The canvas transform is relative to this. </member> @@ -204,7 +218,7 @@ <member name="lod_threshold" type="float" setter="set_lod_threshold" getter="get_lod_threshold" default="1.0"> </member> <member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA" default="0"> - The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems. + The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 2 or 4 is best unless targeting very high-end systems. See also bilinear scaling 3d [member scaling_3d_mode] for supersampling, which provides higher quality but is much more expensive. </member> <member name="own_world_3d" type="bool" setter="set_use_own_world_3d" getter="is_using_own_world_3d" default="false"> If [code]true[/code], the viewport will use the [World3D] defined in [member world_3d]. @@ -212,8 +226,14 @@ <member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking" default="false"> If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. </member> - <member name="scale_3d" type="int" setter="set_scale_3d" getter="get_scale_3d" enum="Viewport.Scale3D" default="0"> - The scale at which 3D content is rendered. + <member name="scaling_3d_mode" type="int" setter="set_scaling_3d_mode" getter="get_scaling_3d_mode" enum="Viewport.Scaling3DMode" default="0"> + Sets scaling 3d mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible. + To control this property on the root viewport, set the [member ProjectSettings.rendering/scaling_3d/mode] project setting. + </member> + <member name="scaling_3d_scale" type="float" setter="set_scaling_3d_scale" getter="get_scaling_3d_scale" default="1.0"> + Scales the 3D render buffer based on the viewport size uses an image filter specified in [member ProjectSettings.rendering/scaling_3d/mode] to scale the output image to the full viewport size. Values lower than [code]1.0[/code] can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than [code]1.0[/code] are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also [member ProjectSettings.rendering/anti_aliasing/quality/msaa] for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons. + When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale. + To control this property on the root viewport, set the [member ProjectSettings.rendering/scaling_3d/scale] project setting. </member> <member name="screen_space_aa" type="int" setter="set_screen_space_aa" getter="get_screen_space_aa" enum="Viewport.ScreenSpaceAA" default="0"> Sets the screen-space antialiasing method used. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry. @@ -275,16 +295,6 @@ </signal> </signals> <constants> - <constant name="SCALE_3D_DISABLED" value="0" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_75_PERCENT" value="1" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_50_PERCENT" value="2" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_33_PERCENT" value="3" enum="Scale3D"> - </constant> - <constant name="SCALE_3D_25_PERCENT" value="4" enum="Scale3D"> - </constant> <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv"> This quadrant will not be used. </constant> @@ -309,6 +319,15 @@ <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv"> Represents the size of the [enum ShadowAtlasQuadrantSubdiv] enum. </constant> + <constant name="SCALING_3D_MODE_BILINEAR" value="0" enum="Scaling3DMode"> + Enables bilinear scaling on 3D viewports. The amount of scaling can be set using [member scaling_3d_scale]. Values less then [code]1.0[/code] will result in undersampling while values greater than [code]1.0[/code] will result in supersampling. A value of [code]1.0[/code] disables scaling. + </constant> + <constant name="SCALING_3D_MODE_FSR" value="1" enum="Scaling3DMode"> + Enables FSR upscaling on 3D viewports. The amount of scaling can be set using [member scaling_3d_scale]. Values less then [code]1.0[/code] will be result in the viewport being upscaled using FSR. Values greater than [code]1.0[/code] are not supported and bilinear supersampling will be used instead. A value of [code]1.0[/code] disables scaling. + </constant> + <constant name="SCALING_3D_MODE_MAX" value="2" enum="Scaling3DMode"> + Represents the size of the [enum Scaling3DMode] enum. + </constant> <constant name="MSAA_DISABLED" value="0" enum="MSAA"> Multisample antialiasing mode disabled. This is the default value, and is also the fastest setting. </constant> diff --git a/doc/classes/VisualScriptCustomNodes.xml b/doc/classes/VisualScriptCustomNodes.xml deleted file mode 100644 index 1681da7653..0000000000 --- a/doc/classes/VisualScriptCustomNodes.xml +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptCustomNodes" inherits="Object" version="4.0"> - <brief_description> - Manages custom nodes for the Visual Script editor. - </brief_description> - <description> - This singleton can be used to manage (i.e., add or remove) custom nodes for the Visual Script editor. - </description> - <tutorials> - </tutorials> - <methods> - <method name="add_custom_node"> - <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="category" type="String" /> - <argument index="2" name="script" type="Script" /> - <description> - Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. - </description> - </method> - <method name="remove_custom_node"> - <return type="void" /> - <argument index="0" name="name" type="String" /> - <argument index="1" name="category" type="String" /> - <description> - Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. - </description> - </method> - </methods> - <signals> - <signal name="custom_nodes_updated"> - <description> - Emitted when a custom Visual Script node is added or removed. - </description> - </signal> - </signals> -</class> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index cdb9de4f86..d7b4673b9f 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -176,7 +176,10 @@ </constant> <constant name="TYPE_SKY" value="8" enum="Type"> </constant> - <constant name="TYPE_MAX" value="9" enum="Type"> + <constant name="TYPE_FOG" value="9" enum="Type"> + A compute shader that runs for each froxel of the volumetric fog map. + </constant> + <constant name="TYPE_MAX" value="10" enum="Type"> Represents the size of the [enum Type] enum. </constant> <constant name="NODE_ID_INVALID" value="-1"> diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 2cff70b4f1..cebe7f215f 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -7,7 +7,7 @@ Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node has also connection ports that allow to connect it to another nodes and control the flow of the shader. </description> <tutorials> - <link title="VisualShaders">https://docs.godotengine.org/en/latest/tutorials/shading/visual_shaders.html</link> + <link title="VisualShaders">$DOCS_URL/tutorials/shaders/visual_shaders.html</link> </tutorials> <methods> <method name="clear_default_input_values"> diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index b87b59c3e4..995f2796dd 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -13,7 +13,7 @@ [/codeblock] </description> <tutorials> - <link title="Visual Shader plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/visual_shader_plugins.html</link> + <link title="Visual Shader plugins">$DOCS_URL/tutorials/plugins/editor/visual_shader_plugins.html</link> </tutorials> <methods> <method name="_get_category" qualifiers="virtual const"> @@ -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. diff --git a/doc/classes/VisualShaderNodeInput.xml b/doc/classes/VisualShaderNodeInput.xml index 68f64ad98e..a7b501c6a0 100644 --- a/doc/classes/VisualShaderNodeInput.xml +++ b/doc/classes/VisualShaderNodeInput.xml @@ -7,7 +7,7 @@ Gives access to input variables (built-ins) available for the shader. See the shading reference for the list of available built-ins for each shader type (check [code]Tutorials[/code] section for link). </description> <tutorials> - <link title="Shading reference index">https://docs.godotengine.org/en/stable/tutorials/shading/shading_reference/index.html</link> + <link title="Shading reference index">$DOCS_URL/tutorials/shaders/shader_reference/index.html</link> </tutorials> <methods> <method name="get_input_real_name" qualifiers="const"> diff --git a/doc/classes/VisualShaderNodeParticleEmitter.xml b/doc/classes/VisualShaderNodeParticleEmitter.xml index 03ceb3adea..fa46b25fa9 100644 --- a/doc/classes/VisualShaderNodeParticleEmitter.xml +++ b/doc/classes/VisualShaderNodeParticleEmitter.xml @@ -1,9 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualShaderNodeParticleEmitter" inherits="VisualShaderNode" version="4.0"> <brief_description> + A base class for particle emitters. </brief_description> <description> </description> <tutorials> </tutorials> + <members> + <member name="mode_2d" type="bool" setter="set_mode_2d" getter="is_mode_2d" default="false"> + If [code]true[/code], the result of this emitter is projected to 2D space. By default it is [code]false[/code] and meant for use in 3D space. + </member> + </members> </class> diff --git a/doc/classes/VisualShaderNodeParticleMeshEmitter.xml b/doc/classes/VisualShaderNodeParticleMeshEmitter.xml new file mode 100644 index 0000000000..7abb330fd3 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleMeshEmitter.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleMeshEmitter" inherits="VisualShaderNodeParticleEmitter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + </member> + <member name="surface_index" type="int" setter="set_surface_index" getter="get_surface_index" default="0"> + </member> + <member name="use_all_surfaces" type="bool" setter="set_use_all_surfaces" getter="is_use_all_surfaces" default="true"> + </member> + </members> +</class> diff --git a/doc/classes/VoxelGI.xml b/doc/classes/VoxelGI.xml index eceb651d5e..2c3605aa1c 100644 --- a/doc/classes/VoxelGI.xml +++ b/doc/classes/VoxelGI.xml @@ -4,12 +4,13 @@ Real-time global illumination (GI) probe. </brief_description> <description> - [VoxelGI]s are used to provide high-quality real-time indirect light to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. [VoxelGI]s need to be baked before using, however, once baked, dynamic objects will receive light from them. Further, lights can be fully dynamic or baked. - Having [VoxelGI]s in a scene can be expensive, the quality of the probe can be turned down in exchange for better performance in the [ProjectSettings] using [member ProjectSettings.rendering/global_illumination/voxel_gi/quality]. - [b]Note:[/b] Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. + [VoxelGI]s are used to provide high-quality real-time indirect light and reflections to scenes. They precompute the effect of objects that emit light and the effect of static geometry to simulate the behavior of complex light in real-time. [VoxelGI]s need to be baked before having a visible effect. However, once baked, dynamic objects will receive light from them. Furthermore, lights can be fully dynamic or baked. + [b]Procedural generation:[/b] [VoxelGI] can be baked in an exported project, which makes it suitable for procedurally generated or user-built levels as long as all the geometry is generated in advance. For games where geometry is generated at any time during gameplay, SDFGI is more suitable (see [member Environment.sdfgi_enabled]). + [b]Performance:[/b] [VoxelGI] is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider [LightmapGI] instead). To improve performance, adjust [member ProjectSettings.rendering/global_illumination/voxel_gi/quality] and enable [member ProjectSettings.rendering/global_illumination/gi/use_half_resolution] in the Project Settings. To provide a fallback for low-end hardware, consider adding an option to disable [VoxelGI] in your project's options menus. A [VoxelGI] node can be disabled by hiding it. + [b]Note:[/b] Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh. To further prevent light leaks, you can also strategically place temporary [MeshInstance3D] nodes with their [member GeometryInstance3D.gi_mode] set to [constant GeometryInstance3D.GI_MODE_BAKED]. These temporary nodes can then be hidden after baking the [VoxelGI] node. </description> <tutorials> - <link title="GI probes">https://docs.godotengine.org/en/latest/tutorials/3d/voxel_gi.html</link> + <link title="GI probes">$DOCS_URL/tutorials/3d/gi_probes.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> @@ -19,6 +20,7 @@ <argument index="1" name="create_visual_debug" type="bool" default="false" /> <description> Bakes the effect from all [GeometryInstance3D]s marked with [constant GeometryInstance3D.GI_MODE_BAKED] and [Light3D]s marked with either [constant Light3D.BAKE_DYNAMIC] or [constant Light3D.BAKE_STATIC]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [VoxelGI]'s data and debug any issues that may be occurring. + [b]Note:[/b] [method bake] works from the editor and in exported projects. This makes it suitable for procedurally generated or user-built levels. Baking a [VoxelGI] node generally takes from 5 to 20 seconds in most scenes. Reducing [member subdiv] can speed up baking. </description> </method> <method name="debug_bake"> @@ -50,7 +52,7 @@ Use 256 subdivisions. </constant> <constant name="SUBDIV_512" value="3" enum="Subdiv"> - Use 512 subdivisions. This is the highest quality setting, but the slowest. On lower-end hardware this could cause the GPU to stall. + Use 512 subdivisions. This is the highest quality setting, but the slowest. On lower-end hardware, this could cause the GPU to stall. </constant> <constant name="SUBDIV_MAX" value="4" enum="Subdiv"> Represents the size of the [enum Subdiv] enum. diff --git a/doc/classes/VoxelGIData.xml b/doc/classes/VoxelGIData.xml index f0bd2a0601..36907c88ba 100644 --- a/doc/classes/VoxelGIData.xml +++ b/doc/classes/VoxelGIData.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VoxelGIData" inherits="Resource" version="4.0"> <brief_description> + Contains baked voxel global illumination data for use in a [VoxelGI] node. </brief_description> <description> + [VoxelGIData] contains baked voxel global illumination for use in a [VoxelGI] node. [VoxelGIData] also offers several properties to adjust the final appearance of the global illumination. These properties can be adjusted at run-time without having to bake the [VoxelGI] node again. + [b]Note:[/b] To prevent text-based scene files ([code].tscn[/code]) from growing too much and becoming slow to load and save, always save [VoxelGIData] to an external binary resource file ([code].res[/code]) instead of embedding it within the scene. This can be done by clicking the dropdown arrow next to the [VoxelGIData] resource, choosing [b]Edit[/b], clicking the floppy disk icon at the top of the inspector then choosing [b]Save As...[/b]. </description> <tutorials> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> @@ -23,6 +26,8 @@ <method name="get_bounds" qualifiers="const"> <return type="AABB" /> <description> + Returns the bounds of the baked voxel data as an [AABB], which should match [member VoxelGI.extents] after being baked (which only contains the size as a [Vector3]). + [b]Note:[/b] If the extents were modified without baking the VoxelGI data, then the value of [method get_bounds] and [member VoxelGI.extents] will not match. </description> </method> <method name="get_data_cells" qualifiers="const"> @@ -53,18 +58,25 @@ </methods> <members> <member name="bias" type="float" setter="set_bias" getter="get_bias" default="1.5"> + The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. To prioritize hiding self-reflections over lighting quality, set [member bias] to [code]0.0[/code] and [member normal_bias] to a value between [code]1.0[/code] and [code]2.0[/code]. </member> <member name="dynamic_range" type="float" setter="set_dynamic_range" getter="get_dynamic_range" default="4.0"> + The dynamic range to use ([code]1.0[/code] represents a low dynamic range scene brightness). Higher values can be used to provide brighter indirect lighting, at the cost of more visible color banding in dark areas (both in indirect lighting and reflections). To avoid color banding, it's recommended to use the lowest value that does not result in visible light clipping. </member> <member name="energy" type="float" setter="set_energy" getter="get_energy" default="1.0"> + The energy of the indirect lighting and reflections produced by the [VoxelGI] node. Higher values result in brighter indirect lighting. If indirect lighting looks too flat, try decreasing [member propagation] while increasing [member energy] at the same time. See also [member use_two_bounces] which influences the indirect lighting's effective brightness. </member> <member name="interior" type="bool" setter="set_interior" getter="is_interior" default="false"> + If [code]true[/code], [Environment] lighting is ignored by the [VoxelGI] node. If [code]false[/code], [Environment] lighting is taken into account by the [VoxelGI] node. [Environment] lighting updates in real-time, which means it can be changed without having to bake the [VoxelGI] node again. </member> <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias" default="0.0"> + The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. See also [member bias]. To prioritize hiding self-reflections over lighting quality, set [member bias] to [code]0.0[/code] and [member normal_bias] to a value between [code]1.0[/code] and [code]2.0[/code]. </member> <member name="propagation" type="float" setter="set_propagation" getter="get_propagation" default="0.7"> + If indirect lighting looks too flat, try decreasing [member propagation] while increasing [member energy] at the same time. See also [member use_two_bounces] which influences the indirect lighting's effective brightness. </member> <member name="use_two_bounces" type="bool" setter="set_use_two_bounces" getter="is_using_two_bounces" default="false"> + If [code]true[/code], performs two bounces of indirect lighting instead of one. This makes indirect lighting look more natural and brighter at a small performance cost. The second bounce is also visible in reflections. If the scene appears too bright after enabling [member use_two_bounces], adjust [member propagation] and [member energy]. </member> </members> </class> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 15d844aacb..3fee1feae8 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -59,6 +59,21 @@ <description> </description> </method> + <method name="get_theme_default_base_scale" qualifiers="const"> + <return type="float" /> + <description> + </description> + </method> + <method name="get_theme_default_font" qualifiers="const"> + <return type="Font" /> + <description> + </description> + </method> + <method name="get_theme_default_font_size" qualifiers="const"> + <return type="int" /> + <description> + </description> + </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> <argument index="0" name="name" type="StringName" /> @@ -215,6 +230,12 @@ <description> </description> </method> + <method name="reset_size"> + <return type="void" /> + <description> + Resets the size to the minimum size, which is the max of [member min_size] and (if [member wrap_controls] is enabled) [method get_contents_minimum_size]. This is equivalent to calling [code]set_size(Vector2i())[/code] (or any size below the minimum). + </description> + </method> <method name="set_flag"> <return type="void" /> <argument index="0" name="flag" type="int" enum="Window.Flags" /> @@ -369,7 +390,7 @@ </constant> <constant name="MODE_FULLSCREEN" value="3" enum="Mode"> Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project. - Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. + Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. </constant> <constant name="FLAG_RESIZE_DISABLED" value="0" enum="Flags"> The window's ability to be resized. diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index a6a4701dd4..47ab4b3612 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -7,7 +7,7 @@ Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. </description> <tutorials> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <members> <member name="canvas" type="RID" setter="" getter="get_canvas"> diff --git a/doc/classes/World3D.xml b/doc/classes/World3D.xml index 136ca2c598..fd2f96985c 100644 --- a/doc/classes/World3D.xml +++ b/doc/classes/World3D.xml @@ -7,7 +7,7 @@ Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Node3D nodes register their resources into the current world. </description> <tutorials> - <link title="Ray-casting">https://docs.godotengine.org/en/latest/tutorials/physics/ray-casting.html</link> + <link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link> </tutorials> <members> <member name="camera_effects" type="CameraEffects" setter="set_camera_effects" getter="get_camera_effects"> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml index bd25a74c5b..793479e074 100644 --- a/doc/classes/WorldEnvironment.xml +++ b/doc/classes/WorldEnvironment.xml @@ -9,7 +9,7 @@ The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). Usually, these are added in order to improve the realism/color balance of the scene. </description> <tutorials> - <link title="Environment and post-processing">https://docs.godotengine.org/en/latest/tutorials/3d/environment_and_post_processing.html</link> + <link title="Environment and post-processing">$DOCS_URL/tutorials/3d/environment_and_post_processing.html</link> <link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link> <link title="2D HDR Demo">https://godotengine.org/asset-library/asset/110</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> diff --git a/doc/classes/XRAnchor3D.xml b/doc/classes/XRAnchor3D.xml index 94fc8fc13d..2c54c728ed 100644 --- a/doc/classes/XRAnchor3D.xml +++ b/doc/classes/XRAnchor3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XRAnchor3D" inherits="Node3D" version="4.0"> +<class name="XRAnchor3D" inherits="XRNode3D" version="4.0"> <brief_description> An anchor point in AR space. </brief_description> @@ -11,24 +11,6 @@ <tutorials> </tutorials> <methods> - <method name="get_anchor_name" qualifiers="const"> - <return type="String" /> - <description> - Returns the name given to this anchor. - </description> - </method> - <method name="get_is_active" qualifiers="const"> - <return type="bool" /> - <description> - Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this ID is currently known. - </description> - </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh" /> - <description> - If provided by the [XRInterface], this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. - </description> - </method> <method name="get_plane" qualifiers="const"> <return type="Plane" /> <description> @@ -42,17 +24,4 @@ </description> </method> </methods> - <members> - <member name="anchor_id" type="int" setter="set_anchor_id" getter="get_anchor_id" default="1"> - The anchor's ID. You can set this before the anchor itself exists. The first anchor gets an ID of [code]1[/code], the second an ID of [code]2[/code], etc. When anchors get removed, the engine can then assign the corresponding ID to new anchors. The most common situation where anchors "disappear" is when the AR server identifies that two anchors represent different parts of the same plane and merges them. - </member> - </members> - <signals> - <signal name="mesh_updated"> - <argument index="0" name="mesh" type="Mesh" /> - <description> - Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being [code]mesh_updated[/code]. - </description> - </signal> - </signals> </class> diff --git a/doc/classes/XRCamera3D.xml b/doc/classes/XRCamera3D.xml index 682a797b5e..ca81f5b169 100644 --- a/doc/classes/XRCamera3D.xml +++ b/doc/classes/XRCamera3D.xml @@ -8,6 +8,6 @@ The position and orientation of this node is automatically updated by the XR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that, in contrast to the XR Controller, the render thread has access to the most up-to-date tracking data of the HMD and the location of the XRCamera3D can lag a few milliseconds behind what is used for rendering as a result. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> </class> diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index 1a05a7b651..0e2785f246 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XRController3D" inherits="Node3D" version="4.0"> +<class name="XRController3D" inherits="XRNode3D" version="4.0"> <brief_description> A spatial node representing a spatially-tracked controller. </brief_description> @@ -7,63 +7,41 @@ This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers. Controllers are linked by their ID. You can create controller nodes before the controllers are available. If your game always uses two controllers (one for each hand), you can predefine the controllers with ID 1 and 2; they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add XRController3D nodes to your scene. The position of the controller node is automatically updated by the [XRServer]. This makes this node ideal to add child nodes to visualize the controller. + As many XR runtimes now use a configurable action map all inputs are named. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> <methods> - <method name="get_controller_name" qualifiers="const"> - <return type="String" /> + <method name="get_axis" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="name" type="StringName" /> <description> - If active, returns the name of the associated controller if provided by the AR/VR SDK used. + Returns a [Vector2] for the input with the given [code]name[/code]. This is used for thumbsticks and thumbpads found on many controllers. </description> </method> - <method name="get_is_active" qualifiers="const"> - <return type="bool" /> + <method name="get_tracker_hand" qualifiers="const"> + <return type="int" enum="XRPositionalTracker.TrackerHand" /> <description> - Returns [code]true[/code] if the bound controller is active. XR systems attempt to track active controllers. + Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand]. </description> </method> - <method name="get_joystick_axis" qualifiers="const"> + <method name="get_value" qualifiers="const"> <return type="float" /> - <argument index="0" name="axis" type="int" /> - <description> - Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. - </description> - </method> - <method name="get_joystick_id" qualifiers="const"> - <return type="int" /> - <description> - Returns the ID of the joystick object bound to this. Every controller tracked by the [XRServer] that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. - </description> - </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh" /> + <argument index="0" name="name" type="StringName" /> <description> - If provided by the [XRInterface], this returns a mesh associated with the controller. This can be used to visualize the controller. - </description> - </method> - <method name="get_tracker_hand" qualifiers="const"> - <return type="int" enum="XRPositionalTracker.TrackerHand" /> - <description> - Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand]. + Returns a numeric value for the input with the given [code]name[/code]. This is used for triggers and grip sensors. </description> </method> <method name="is_button_pressed" qualifiers="const"> <return type="bool" /> - <argument index="0" name="button" type="int" /> + <argument index="0" name="name" type="StringName" /> <description> - Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoyButton]. + Returns [code]true[/code] if the button with the given [code]name[/code] is pressed. </description> </method> </methods> <members> - <member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id" default="1"> - The controller's ID. - A controller ID of 0 is unbound and will always result in an inactive node. Controller ID 1 is reserved for the first controller that identifies itself as the left-hand controller and ID 2 is reserved for the first controller that identifies itself as the right-hand controller. - For any other controller that the [XRServer] detects, we continue with controller ID 3. - When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off. - </member> <member name="rumble" type="float" setter="set_rumble" getter="get_rumble" default="0.0"> The degree to which the controller vibrates. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member XRPositionalTracker.rumble] accordingly. This is a useful property to animate if you want the controller to vibrate for a limited duration. @@ -71,21 +49,29 @@ </members> <signals> <signal name="button_pressed"> - <argument index="0" name="button" type="int" /> + <argument index="0" name="name" type="String" /> <description> Emitted when a button on this controller is pressed. </description> </signal> <signal name="button_released"> - <argument index="0" name="button" type="int" /> + <argument index="0" name="name" type="String" /> <description> Emitted when a button on this controller is released. </description> </signal> - <signal name="mesh_updated"> - <argument index="0" name="mesh" type="Mesh" /> + <signal name="input_axis_changed"> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="Vector2" /> + <description> + Emitted when a thumbstick or thumbpad on this controller is moved. + </description> + </signal> + <signal name="input_value_changed"> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="float" /> <description> - Emitted when the mesh associated with the controller changes or when one becomes available. Generally speaking this will be a static mesh after becoming available. + Emitted when a trigger or similar input on this controller changes value. </description> </signal> </signals> diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 2a740ab1e8..3b03447ed1 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -8,7 +8,7 @@ Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through [XRServer]. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> <methods> <method name="get_camera_feed_id"> @@ -29,6 +29,12 @@ Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc). </description> </method> + <method name="get_play_area" qualifiers="const"> + <return type="PackedVector3Array" /> + <description> + Returns an array of vectors that denotes the physical play area mapped to the virtual space around the [XROrigin3D] point. The points form a convex polygon that can be used to react to or visualise the play area. This returns an empty array if this feature is not supported or if the information is not yet available. + </description> + </method> <method name="get_render_target_size"> <return type="Vector2" /> <description> @@ -63,6 +69,34 @@ Is [code]true[/code] if this interface has been initialised. </description> </method> + <method name="set_play_area_mode"> + <return type="bool" /> + <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <description> + Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. + </description> + </method> + <method name="supports_play_area_mode"> + <return type="bool" /> + <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <description> + Call this to find out if a given play area mode is supported by this interface. + </description> + </method> + <method name="trigger_haptic_pulse"> + <return type="void" /> + <argument index="0" name="action_name" type="String" /> + <argument index="1" name="tracker_name" type="StringName" /> + <argument index="2" name="frequency" type="float" /> + <argument index="3" name="amplitude" type="float" /> + <argument index="4" name="duration_sec" type="float" /> + <argument index="5" name="delay_sec" type="float" /> + <description> + Triggers a haptic pulse on a device associated with this interface. + [code]action_name[/code] is the name of the action for this pulse. + [code]tracker_name[/code] is optional and can be used to direct the pulse to a specific device provided that device is bound to this haptic. + </description> + </method> <method name="uninitialize"> <return type="void" /> <description> @@ -77,7 +111,18 @@ <member name="interface_is_primary" type="bool" setter="set_primary" getter="is_primary" default="false"> [code]true[/code] if this is the primary interface. </member> + <member name="xr_play_area_mode" type="int" setter="set_play_area_mode" getter="get_play_area_mode" enum="XRInterface.PlayAreaMode" default="0"> + The play area mode for this interface. + </member> </members> + <signals> + <signal name="play_area_changed"> + <argument index="0" name="mode" type="int" /> + <description> + Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation. + </description> + </signal> + </signals> <constants> <constant name="XR_NONE" value="0" enum="Capabilities"> No XR capabilities. @@ -88,20 +133,17 @@ <constant name="XR_STEREO" value="2" enum="Capabilities"> This interface supports stereoscopic rendering. </constant> - <constant name="XR_AR" value="4" enum="Capabilities"> - This interface supports AR (video background and real world tracking). - </constant> - <constant name="XR_EXTERNAL" value="8" enum="Capabilities"> - This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of [method get_render_target_size]). Using a separate viewport node frees up the main viewport for other purposes. + <constant name="XR_QUAD" value="4" enum="Capabilities"> + This interface supports quad rendering (not yet supported by Godot). </constant> - <constant name="EYE_MONO" value="0" enum="Eyes"> - Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. + <constant name="XR_VR" value="8" enum="Capabilities"> + this interface supports VR. </constant> - <constant name="EYE_LEFT" value="1" enum="Eyes"> - Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. + <constant name="XR_AR" value="16" enum="Capabilities"> + This interface supports AR (video background and real world tracking). </constant> - <constant name="EYE_RIGHT" value="2" enum="Eyes"> - Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. + <constant name="XR_EXTERNAL" value="32" enum="Capabilities"> + This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of [method get_render_target_size]). Using a separate viewport node frees up the main viewport for other purposes. </constant> <constant name="XR_NORMAL_TRACKING" value="0" enum="TrackingStatus"> Tracking is behaving as expected. @@ -118,5 +160,20 @@ <constant name="XR_NOT_TRACKING" value="4" enum="TrackingStatus"> Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.). </constant> + <constant name="XR_PLAY_AREA_UNKNOWN" value="0" enum="PlayAreaMode"> + Play area mode not set or not available. + </constant> + <constant name="XR_PLAY_AREA_3DOF" value="1" enum="PlayAreaMode"> + Play area only supports orientation tracking, no positional tracking, area will center around player. + </constant> + <constant name="XR_PLAY_AREA_SITTING" value="2" enum="PlayAreaMode"> + Player is in seated position, limited positional tracking, fixed guardian around player. + </constant> + <constant name="XR_PLAY_AREA_ROOMSCALE" value="3" enum="PlayAreaMode"> + Player is free to move around, full positional tracking. + </constant> + <constant name="XR_PLAY_AREA_STAGE" value="4" enum="PlayAreaMode"> + Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled. + </constant> </constants> </class> diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 84b46e0ddd..d2bb6aa59a 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -41,6 +41,16 @@ <description> </description> </method> + <method name="_get_play_area" qualifiers="virtual const"> + <return type="PackedVector3Array" /> + <description> + </description> + </method> + <method name="_get_play_area_mode" qualifiers="virtual const"> + <return type="int" /> + <description> + </description> + </method> <method name="_get_projection_for_view" qualifiers="virtual"> <return type="PackedFloat64Array" /> <argument index="0" name="view" type="int" /> @@ -55,6 +65,17 @@ <description> </description> </method> + <method name="_get_suggested_pose_names" qualifiers="virtual const"> + <return type="PackedStringArray" /> + <argument index="0" name="tracker_name" type="StringName" /> + <description> + </description> + </method> + <method name="_get_suggested_tracker_names" qualifiers="virtual const"> + <return type="PackedStringArray" /> + <description> + </description> + </method> <method name="_get_tracking_status" qualifiers="virtual const"> <return type="int" /> <description> @@ -99,6 +120,29 @@ <description> </description> </method> + <method name="_set_play_area_mode" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="mode" type="int" /> + <description> + </description> + </method> + <method name="_supports_play_area_mode" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> + <description> + </description> + </method> + <method name="_trigger_haptic_pulse" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="action_name" type="String" /> + <argument index="1" name="tracker_name" type="StringName" /> + <argument index="2" name="frequency" type="float" /> + <argument index="3" name="amplitude" type="float" /> + <argument index="4" name="duration_sec" type="float" /> + <argument index="5" name="delay_sec" type="float" /> + <description> + </description> + </method> <method name="_uninitialize" qualifiers="virtual"> <return type="void" /> <description> diff --git a/doc/classes/XRNode3D.xml b/doc/classes/XRNode3D.xml new file mode 100644 index 0000000000..2e6d11d729 --- /dev/null +++ b/doc/classes/XRNode3D.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="XRNode3D" inherits="Node3D" version="4.0"> + <brief_description> + A spatial node that has its position automatically updated by the [XRServer]. + </brief_description> + <description> + This node can be bound to a specific pose of a [XRPositionalTracker] and will automatically have its [member Node3D.transform] updated by the [XRServer]. Nodes of this type must be added as children of the [XROrigin3D] node. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_has_tracking_data" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the [member tracker] has current tracking data for the [member pose] being tracked. + </description> + </method> + <method name="get_is_active" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if the [member tracker] has been registered and the [member pose] is being tracked. + </description> + </method> + <method name="get_pose"> + <return type="XRPose" /> + <description> + Returns the [XRPose] containing the current state of the pose being tracked. This gives access to additional properties of this pose. + </description> + </method> + <method name="trigger_haptic_pulse"> + <return type="void" /> + <argument index="0" name="action_name" type="String" /> + <argument index="1" name="frequency" type="float" /> + <argument index="2" name="amplitude" type="float" /> + <argument index="3" name="duration_sec" type="float" /> + <argument index="4" name="delay_sec" type="float" /> + <description> + Triggers a haptic pulse on a device associated with this interface. + [code]action_name[/code] is the name of the action for this pulse. + </description> + </method> + </methods> + <members> + <member name="pose" type="StringName" setter="set_pose_name" getter="get_pose_name" default="&"default""> + The name of the pose we're bound to. Which poses a tracker supports is not known during design time. + Godot defines number of standard pose names such as [code]aim[/code] and [code]grip[/code] but other may be configured within a given [XRInterface]. + </member> + <member name="tracker" type="StringName" setter="set_tracker" getter="get_tracker" default="&"""> + The name of the tracker we're bound to. Which trackers are available is not known during design time. + Godot defines a number of standard trackers such as [code]left_hand[/code] and [code]right_hand[/code] but others may be configured within a given [XRInterface]. + </member> + </members> +</class> diff --git a/doc/classes/XROrigin3D.xml b/doc/classes/XROrigin3D.xml index cdf319093c..fc15102976 100644 --- a/doc/classes/XROrigin3D.xml +++ b/doc/classes/XROrigin3D.xml @@ -10,7 +10,7 @@ For example, if your character is driving a car, the XROrigin3D node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> <members> <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale" default="1.0"> diff --git a/doc/classes/XRPose.xml b/doc/classes/XRPose.xml new file mode 100644 index 0000000000..0de2bc9e48 --- /dev/null +++ b/doc/classes/XRPose.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="XRPose" inherits="RefCounted" version="4.0"> + <brief_description> + This object contains all data related to a pose on a tracked object. + </brief_description> + <description> + XR runtimes often identify multiple locations on devices such as controllers that are spatially tracked. + Orientation, location, linear velocity and angular velocity are all provided for each pose by the XR runtime. This object contains this state of a pose. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_adjusted_transform" qualifiers="const"> + <return type="Transform3D" /> + <description> + Returns the [member transform] with world scale and our reference frame applied. This is the transform used to position [XRNode3D] objects. + </description> + </method> + </methods> + <members> + <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity" default="Vector3(0, 0, 0)"> + The angular velocity for this pose. + </member> + <member name="has_tracking_data" type="bool" setter="set_has_tracking_data" getter="get_has_tracking_data" default="false"> + If [code]true[/code] our tracking data is up to date. If [code]false[/code] we're no longer receiving new tracking data and our state is whatever that last valid state was. + </member> + <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity" default="Vector3(0, 0, 0)"> + The linear velocity of this pose. + </member> + <member name="name" type="StringName" setter="set_name" getter="get_name" default="&"""> + The name of this pose. Pose names are often driven by an action map setup by the user. Godot does suggest a number of pose names that it expects [XRInterface]s to implement: + - [code]root[/code] defines a root location, often used for tracked objects that do not have further nodes. + - [code]aim[/code] defines the tip of a controller with the orientation pointing outwards, for instance: add your raycasts to this. + - [code]grip[/code] defines the location where the user grips the controller + - [code]skeleton[/code] defines the root location a hand mesh should be placed when using hand tracking and the animated skeleton supplied by the XR runtime. + </member> + <member name="transform" type="Transform3D" setter="set_transform" getter="get_transform" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> + The transform containing the original and transform as reported by the XR runtime. + </member> + </members> +</class> diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index 8cc7c872b6..439bcfc382 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -5,86 +5,113 @@ </brief_description> <description> An instance of this object represents a device that is tracked, such as a controller or anchor point. HMDs aren't represented here as they are handled internally. - As controllers are turned on and the AR/VR interface detects them, instances of this object are automatically added to this list of active tracking objects accessible through the [XRServer]. - The [XRController3D] and [XRAnchor3D] both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDNative-based interfaces can interact with them. + As controllers are turned on and the [XRInterface] detects them, instances of this object are automatically added to this list of active tracking objects accessible through the [XRServer]. + The [XRController3D] and [XRAnchor3D] both consume objects of this type and should be used in your project. The positional trackers are just under-the-hood objects that make this all work. These are mostly exposed so that GDExtension-based interfaces can interact with them. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> <methods> - <method name="get_joy_id" qualifiers="const"> - <return type="int" /> + <method name="get_input" qualifiers="const"> + <return type="Variant" /> + <argument index="0" name="name" type="StringName" /> <description> - If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID. + Returns an input for this tracker. It can return a boolean, float or [Vector2] value depending on whether the input is a button, trigger or thumbstick/thumbpad. </description> </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh" /> + <method name="get_pose" qualifiers="const"> + <return type="XRPose" /> + <argument index="0" name="name" type="StringName" /> <description> - Returns the mesh related to a controller or anchor point if one is available. + Returns the current [XRPose] state object for the bound [code]pose[/code]. </description> </method> - <method name="get_orientation" qualifiers="const"> - <return type="Basis" /> + <method name="has_pose" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="name" type="StringName" /> <description> - Returns the controller's orientation matrix. + Returns [code]true[/code] if the bound [code]tracker[/code] is available and is currently tracking the bound [code]pose[/code]. </description> </method> - <method name="get_position" qualifiers="const"> - <return type="Vector3" /> + <method name="invalidate_pose"> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> <description> - Returns the world-space controller position. + Marks this pose as invalid, we don't clear the last reported state but it allows users to decide if trackers need to be hidden if we loose tracking or just remain at their last known position. </description> </method> - <method name="get_tracker_hand" qualifiers="const"> - <return type="int" enum="XRPositionalTracker.TrackerHand" /> + <method name="set_input"> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> + <argument index="1" name="value" type="Variant" /> <description> - Returns the hand holding this tracker, if known. See [enum TrackerHand] constants. + Changes the value for the given input. This method is called by a [XRInterface] implementation and should not be used directly. </description> </method> - <method name="get_tracker_id" qualifiers="const"> - <return type="int" /> + <method name="set_pose"> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> + <argument index="1" name="transform" type="Transform3D" /> + <argument index="2" name="linear_velocity" type="Vector3" /> + <argument index="3" name="angular_velocity" type="Vector3" /> <description> - Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the [XRController3D] and [XRAnchor3D] nodes. + Sets the transform, linear velocity and angular velocity for the given pose. This method is called by a [XRInterface] implementation and should not be used directly. </description> </method> - <method name="get_tracker_name" qualifiers="const"> - <return type="StringName" /> + </methods> + <members> + <member name="description" type="String" setter="set_tracker_desc" getter="get_tracker_desc" default=""""> + The description of this tracker. + </member> + <member name="hand" type="int" setter="set_tracker_hand" getter="get_tracker_hand" enum="XRPositionalTracker.TrackerHand" default="0"> + Defines which hand this tracker relates to. + </member> + <member name="name" type="StringName" setter="set_tracker_name" getter="get_tracker_name" default="&"Unknown""> + The unique name of this tracker. The trackers that are available differ between various XR runtimes and can often be configured by the user. Godot maintains a number of reserved names that it expects the [XRInterface] to implement if applicable: + - [code]left_hand[/code] identifies the controller held in the players left hand + - [code]right_hand[/code] identifies the controller held in the players right hand + </member> + <member name="rumble" type="float" setter="set_rumble" getter="get_rumble" default="0.0"> + The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. + </member> + <member name="type" type="int" setter="set_tracker_type" getter="get_tracker_type" enum="XRServer.TrackerType" default="128"> + The type of tracker. + </member> + </members> + <signals> + <signal name="button_pressed"> + <argument index="0" name="name" type="String" /> <description> - Returns the controller or anchor point's name, if applicable. + Emitted when a button on this tracker is pressed. Note that many XR runtimes allow other inputs to be mapped to buttons. </description> - </method> - <method name="get_tracker_type" qualifiers="const"> - <return type="int" enum="XRServer.TrackerType" /> + </signal> + <signal name="button_released"> + <argument index="0" name="name" type="String" /> <description> - Returns the tracker's type, which will be one of the values from the [enum XRServer.TrackerType] enum. + Emitted when a button on this tracker is released. </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform3D" /> - <argument index="0" name="adjust_by_reference_frame" type="bool" /> + </signal> + <signal name="input_axis_changed"> + <argument index="0" name="name" type="String" /> + <argument index="1" name="vector" type="Vector2" /> <description> - Returns the transform combining this device's orientation and position. + Emitted when a thumbstick or thumbpad on this tracker moves. </description> - </method> - <method name="is_tracking_orientation" qualifiers="const"> - <return type="bool" /> + </signal> + <signal name="input_value_changed"> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="float" /> <description> - Returns [code]true[/code] if this device is tracking orientation. + Emitted when a trigger or similar input on this tracker changes value. </description> - </method> - <method name="is_tracking_position" qualifiers="const"> - <return type="bool" /> + </signal> + <signal name="pose_changed"> + <argument index="0" name="pose" type="XRPose" /> <description> - Returns [code]true[/code] if this device is tracking position. + Emitted when the state of a pose tracked by this tracker changes. </description> - </method> - </methods> - <members> - <member name="rumble" type="float" setter="set_rumble" getter="get_rumble" default="0.0"> - The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. - </member> - </members> + </signal> + </signals> <constants> <constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand"> The hand this tracker is held in is unknown or not applicable. diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 85170804cc..3a7fdea8d0 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -7,7 +7,7 @@ The AR/VR server is the heart of our Advanced and Virtual Reality solution and handles all the processing. </description> <tutorials> - <link title="VR tutorial index">https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + <link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link> </tutorials> <methods> <method name="add_interface"> @@ -90,20 +90,21 @@ <method name="get_reference_frame" qualifiers="const"> <return type="Transform3D" /> <description> - Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. + Returns the reference frame transform. Mostly used internally and exposed for GDExtension build interfaces. </description> </method> <method name="get_tracker" qualifiers="const"> <return type="XRPositionalTracker" /> - <argument index="0" name="idx" type="int" /> + <argument index="0" name="tracker_name" type="StringName" /> <description> - Returns the positional tracker at the given ID. + Returns the positional tracker with this name. </description> </method> - <method name="get_tracker_count" qualifiers="const"> - <return type="int" /> + <method name="get_trackers"> + <return type="Dictionary" /> + <argument index="0" name="tracker_types" type="int" /> <description> - Returns the number of trackers currently registered. + Returns a dictionary of trackers for this type. </description> </method> <method name="remove_interface"> @@ -145,7 +146,6 @@ <signal name="tracker_added"> <argument index="0" name="tracker_name" type="StringName" /> <argument index="1" name="type" type="int" /> - <argument index="2" name="id" type="int" /> <description> Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [XRAnchor3D]s for an AR solution, it is important to react to this signal to add the appropriate [XRController3D] or [XRAnchor3D] nodes related to this new tracker. </description> @@ -153,20 +153,29 @@ <signal name="tracker_removed"> <argument index="0" name="tracker_name" type="StringName" /> <argument index="1" name="type" type="int" /> - <argument index="2" name="id" type="int" /> <description> Emitted when a tracker is removed. You should remove any [XRController3D] or [XRAnchor3D] points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). </description> </signal> + <signal name="tracker_updated"> + <argument index="0" name="tracker_name" type="StringName" /> + <argument index="1" name="type" type="int" /> + <description> + Emitted when an existing tracker has been updated. This can happen if the user switches controllers. + </description> + </signal> </signals> <constants> - <constant name="TRACKER_CONTROLLER" value="1" enum="TrackerType"> + <constant name="TRACKER_HEAD" value="1" enum="TrackerType"> + The tracker tracks the location of the players head. This is usually a location centered between the players eyes. Note that for handheld AR devices this can be the current location of the device. + </constant> + <constant name="TRACKER_CONTROLLER" value="2" enum="TrackerType"> The tracker tracks the location of a controller. </constant> - <constant name="TRACKER_BASESTATION" value="2" enum="TrackerType"> + <constant name="TRACKER_BASESTATION" value="4" enum="TrackerType"> The tracker tracks the location of a base station. </constant> - <constant name="TRACKER_ANCHOR" value="4" enum="TrackerType"> + <constant name="TRACKER_ANCHOR" value="8" enum="TrackerType"> The tracker tracks the location and size of an AR anchor. </constant> <constant name="TRACKER_ANY_KNOWN" value="127" enum="TrackerType"> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 39e34a7b96..49f2d2dd7f 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -91,71 +91,74 @@ </description> <tutorials> </tutorials> - <methods> - <method name="bool" qualifiers="constructor"> + <constructors> + <constructor name="bool"> <return type="bool" /> <description> Constructs a default-initialized [bool] set to [code]false[/code]. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="bool" /> <description> Constructs a [bool] as a copy of the given [bool]. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="float" /> <description> Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. </description> - </method> - <method name="bool" qualifiers="constructor"> + </constructor> + <constructor name="bool"> <return type="bool" /> <argument index="0" name="from" type="int" /> <description> Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are different, i.e. one is [code]true[/code] and the other is [code]false[/code]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> - Returns [code]true[/code] if left operand is [code]false[/code] and right operand is [code]true[/code]. + Returns [code]true[/code] if the left operand is [code]false[/code] and the right operand is [code]true[/code]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> + Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> Returns [code]true[/code] if two bools are equal, i.e. both are [code]true[/code] or both are [code]false[/code]. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="bool" /> <description> - Returns [code]true[/code] if left operand is [code]true[/code] and right operand is [code]false[/code]. + Returns [code]true[/code] if the left operand is [code]true[/code] and the right operand is [code]false[/code]. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/float.xml b/doc/classes/float.xml index b45cdd2099..9effe9d5bf 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -12,247 +12,252 @@ <link title="Wikipedia: Double-precision floating-point format">https://en.wikipedia.org/wiki/Double-precision_floating-point_format</link> <link title="Wikipedia: Single-precision floating-point format">https://en.wikipedia.org/wiki/Single-precision_floating-point_format</link> </tutorials> - <methods> - <method name="float" qualifiers="constructor"> + <constructors> + <constructor name="float"> <return type="float" /> <description> Constructs a default-initialized [float] set to [code]0.0[/code]. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="float" /> <description> Constructs a [float] as a copy of the given [float]. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. </description> - </method> - <method name="float" qualifiers="constructor"> + </constructor> + <constructor name="float"> <return type="float" /> <argument index="0" name="from" type="int" /> <description> Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to [code]1.0[/code]. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if two floats are different from each other. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the integer has different value than the float. </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="right" type="float" /> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> <description> - Multiplies two [float]s. + Multiplies each component of the [Color] by the given [float]. + [codeblock] + print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75) + [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> + <description> + Multiplies each component of the [Quaternion] by the given [float]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. + </description> + </operator> + <operator name="operator *"> <return type="Vector2" /> <argument index="0" name="right" type="Vector2" /> <description> Multiplies each component of the [Vector2] by the given [float]. [codeblock] - print(2.5 * Vector2(1, 1)) # Vector2(2.5, 2.5) + print(2.5 * Vector2(1, 3)) # Prints "(2.5, 7.5)" [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> - Multiplies each component of the [Vector2i] by the given [float]. + Multiplies each component of the [Vector2i] by the given [float] truncated to an integer. [codeblock] - print(2.0 * Vector2i(1, 1)) # Vector2i(2.0, 2.0) + print(0.9 * Vector2i(10, 20)) # Prints "(0, 0)" [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3" /> <argument index="0" name="right" type="Vector3" /> <description> Multiplies each component of the [Vector3] by the given [float]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> - Multiplies each component of the [Vector3i] by the given [float]. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - Multiplies each component of the [Quaternion] by the given [float]. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> - <description> - Multiplies each component of the [Color] by the given [float]. + Multiplies each component of the [Vector3i] by the given [float] truncated to an integer. [codeblock] - print(1.5 * Color(0.5, 0.5, 0.5)) # Color(0.75, 0.75, 0.75) + print(0.9 * Vector3i(10, 20, 30)) # Prints "(0, 0, 0)" [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> + <return type="float" /> + <argument index="0" name="right" type="float" /> + <description> + Multiplies two [float]s. + </description> + </operator> + <operator name="operator *"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Multiplies a [float] and an [int]. The result is a [float]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Adds two floats. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Adds a [float] and an [int]. The result is a [float]. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Subtracts a float from a float. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Subtracts an [int] from a [float]. The result is a [float]. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Divides two floats. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="int" /> <description> Divides a [float] by an [int]. The result is a [float]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is less than the right one. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than the given [int]. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is less than or equal to the given [int]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if both floats are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method @GlobalScope.is_equal_approx] or [method @GlobalScope.is_zero_approx] instead, which are more reliable. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if the [float] and the given [int] are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than the right one. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than the given [int]. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] the left float is greater than or equal to the right one. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if this [float] is greater than or equal to the given [int]. </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="float" /> <description> Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="float" /> <description> Returns the negative value of the [float]. If positive, turns the number negative. If negative, turns the number positive. With floats, the number zero can be either positive or negative. </description> - </method> - </methods> + </operator> + </operators> </class> diff --git a/doc/classes/int.xml b/doc/classes/int.xml index a75d11ba4a..d212fe42bf 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -38,66 +38,68 @@ </description> <tutorials> </tutorials> - <methods> - <method name="int" qualifiers="constructor"> + <constructors> + <constructor name="int"> <return type="int" /> <description> Constructs a default-initialized [int] set to [code]0[/code]. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="int" /> <description> Constructs an [int] as a copy of the given [int]. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="bool" /> <description> Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. </description> - </method> - <method name="int" qualifiers="constructor"> + </constructor> + <constructor name="int"> <return type="int" /> <argument index="0" name="from" type="float" /> <description> Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </constructor> + </constructors> + <operators> + <operator name="operator !="> <return type="bool" /> <description> </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if operands are different from each other. </description> - </method> - <method name="operator !=" qualifiers="operator"> + </operator> + <operator name="operator !="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if operands are different from each other. </description> - </method> - <method name="operator %" qualifiers="operator"> + </operator> + <operator name="operator %"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> - Returns the result of the modulo operator for two integers, i.e. the remainder after dividing both numbers. + Returns the remainder after dividing two integers. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using [method @GlobalScope.posmod] instead if you want to handle negative numbers. [codeblock] print(5 % 2) # 1 print(12 % 4) # 0 - print(12 % 2) # 2 + print(-5 % 3) # -2 [/codeblock] </description> - </method> - <method name="operator &" qualifiers="operator"> + </operator> + <operator name="operator &"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -114,98 +116,95 @@ do_stuff() [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="int" /> - <argument index="0" name="right" type="int" /> + </operator> + <operator name="operator *"> + <return type="Color" /> + <argument index="0" name="right" type="Color" /> <description> - Multiplies two [int]s. + Multiplies each component of the [Color] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="float" /> - <argument index="0" name="right" type="float" /> + </operator> + <operator name="operator *"> + <return type="Quaternion" /> + <argument index="0" name="right" type="Quaternion" /> <description> - Multiplies an [int] and a [float]. The result is a [float]. + Multiplies each component of the [Quaternion] by the given [int]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2" /> <argument index="0" name="right" type="Vector2" /> <description> - Multiplies each component of the vector by the given integer. + Multiplies each component of the [Vector2] by the given [int]. [codeblock] print(2 * Vector2(1, 1)) # Vector2(2, 2) [/codeblock] </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector2i" /> <argument index="0" name="right" type="Vector2i" /> <description> - Multiplies each component of the integer vector by the given integer. + Multiplies each component of the [Vector2i] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3" /> <argument index="0" name="right" type="Vector3" /> <description> - Multiplies each component of the vector by the given integer. + Multiplies each component of the [Vector3] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="Vector3i" /> <argument index="0" name="right" type="Vector3i" /> <description> - Multiplies each component of the integer vector by the given integer. - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> - <description> - Multiplies each component of the quaternion by the given integer. + Multiplies each component of the [Vector3i] by the given [int]. </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Color" /> - <argument index="0" name="right" type="Color" /> + </operator> + <operator name="operator *"> + <return type="float" /> + <argument index="0" name="right" type="float" /> <description> - Multiplies each component of the color by the given integer. - [codeblock] - print(2 * Color(0.5, 0.5, 0.5)) # Color(1, 1, 1) - [/codeblock] + Multiplies an [int] and a [float]. The result is a [float]. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator *"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> - Adds two integers. + Multiplies two [int]s. </description> - </method> - <method name="operator +" qualifiers="operator"> + </operator> + <operator name="operator +"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> - Adds an [int] to a [float]. The result is a [float]. + Adds an [int] and a [float]. The result is a [float]. + </description> + </operator> + <operator name="operator +"> + <return type="int" /> + <argument index="0" name="right" type="int" /> + <description> + Adds two integers. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> Subtracts a [float] from an [int]. The result is a [float]. </description> - </method> - <method name="operator -" qualifiers="operator"> + </operator> + <operator name="operator -"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> Subtracts two integers. </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="float" /> <argument index="0" name="right" type="float" /> <description> @@ -214,8 +213,8 @@ print(10 / 3.0) # 3.333... [/codeblock] </description> - </method> - <method name="operator /" qualifiers="operator"> + </operator> + <operator name="operator /"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -225,22 +224,22 @@ print(10 / 3) # 3 [/codeblock] </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than the given [float]. </description> - </method> - <method name="operator <" qualifiers="operator"> + </operator> + <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than the right one. </description> - </method> - <method name="operator <<" qualifiers="operator"> + </operator> + <operator name="operator <<"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -250,69 +249,69 @@ print(10 << 4) # 160 [/codeblock] </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is less than or equal to the given [float]. </description> - </method> - <method name="operator <=" qualifiers="operator"> + </operator> + <operator name="operator <="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is less than or equal to the right one. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <description> </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if the integer is equal to the given [float]. </description> - </method> - <method name="operator ==" qualifiers="operator"> + </operator> + <operator name="operator =="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] if both integers are equal. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than the given [float]. </description> - </method> - <method name="operator >" qualifiers="operator"> + </operator> + <operator name="operator >"> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than the right one. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="float" /> <description> Returns [code]true[/code] if this [int] is greater than or equal to the given [float]. </description> - </method> - <method name="operator >=" qualifiers="operator"> + </operator> + <operator name="operator >="> <return type="bool" /> <argument index="0" name="right" type="int" /> <description> Returns [code]true[/code] the left integer is greater than or equal to the right one. </description> - </method> - <method name="operator >>" qualifiers="operator"> + </operator> + <operator name="operator >>"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -322,8 +321,8 @@ print(10 >> 2) # 2 [/codeblock] </description> - </method> - <method name="operator ^" qualifiers="operator"> + </operator> + <operator name="operator ^"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -333,20 +332,20 @@ print(4 ^ 7) # 3 [/codeblock] </description> - </method> - <method name="operator unary+" qualifiers="operator"> + </operator> + <operator name="operator unary+"> <return type="int" /> <description> Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable. </description> - </method> - <method name="operator unary-" qualifiers="operator"> + </operator> + <operator name="operator unary-"> <return type="int" /> <description> Returns the negated value of the [int]. If positive, turns the number negative. If negative, turns the number positive. If zero, does nothing. </description> - </method> - <method name="operator |" qualifiers="operator"> + </operator> + <operator name="operator |"> <return type="int" /> <argument index="0" name="right" type="int" /> <description> @@ -363,8 +362,8 @@ flags |= 4 [/codeblock] </description> - </method> - <method name="operator ~" qualifiers="operator"> + </operator> + <operator name="operator ~"> <return type="int" /> <description> Returns the result of bitwise [code]NOT[/code] operation for the integer. It's effectively equal to [code]-int + 1[/code]. @@ -373,6 +372,6 @@ print(~7) # -6 [/codeblock] </description> - </method> - </methods> + </operator> + </operators> </class> |