diff options
Diffstat (limited to 'doc')
165 files changed, 1718 insertions, 1390 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index ed0cf5bd5d..552fc41318 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1261,6 +1261,9 @@ <member name="TextServerManager" type="TextServerManager" setter="" getter=""> The [TextServerManager] singleton. </member> + <member name="Time" type="Time" setter="" getter=""> + The [Time] singleton. + </member> <member name="TranslationServer" type="TranslationServer" setter="" getter=""> The [TranslationServer] singleton. </member> diff --git a/doc/classes/AESContext.xml b/doc/classes/AESContext.xml index f577bab992..9dde25028e 100644 --- a/doc/classes/AESContext.xml +++ b/doc/classes/AESContext.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AESContext" inherits="Reference" version="4.0"> +<class name="AESContext" inherits="RefCounted" version="4.0"> <brief_description> Interface to low level AES encryption features. </brief_description> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index fce2b90197..cc7f7072b9 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AStar" inherits="Reference" version="4.0"> +<class name="AStar" inherits="RefCounted" version="4.0"> <brief_description> An implementation of A* to find the shortest paths among connected points in space. </brief_description> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 3efd2f604c..9edc300169 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AStar2D" inherits="Reference" version="4.0"> +<class name="AStar2D" inherits="RefCounted" version="4.0"> <brief_description> AStar class representation that uses 2D vectors as edges. </brief_description> diff --git a/doc/classes/AnimatedSprite2D.xml b/doc/classes/AnimatedSprite2D.xml index 969e9cc85b..d18419f163 100644 --- a/doc/classes/AnimatedSprite2D.xml +++ b/doc/classes/AnimatedSprite2D.xml @@ -22,7 +22,7 @@ <method name="play"> <return type="void"> </return> - <argument index="0" name="anim" type="StringName" default="@"""> + <argument index="0" name="anim" type="StringName" default="&"""> </argument> <argument index="1" name="backwards" type="bool" default="false"> </argument> @@ -39,7 +39,7 @@ </method> </methods> <members> - <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@"default""> + <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="&"default""> The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. </member> <member name="centered" type="bool" setter="set_centered" getter="is_centered" default="true"> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 02ccab4e05..39ab317b79 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -20,7 +20,7 @@ <method name="play"> <return type="void"> </return> - <argument index="0" name="anim" type="StringName" default="@"""> + <argument index="0" name="anim" type="StringName" default="&"""> </argument> <description> Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. @@ -35,7 +35,7 @@ </method> </methods> <members> - <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@"default""> + <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="&"default""> The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. </member> <member name="frame" type="int" setter="set_frame" getter="get_frame" default="0"> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 8204b456d9..fddd8989ab 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -11,6 +11,65 @@ <link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link> </tutorials> <methods> + <method name="_get_caption" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Gets the text caption for this node (used by some editors). + </description> + </method> + <method name="_get_child_by_name" qualifiers="virtual"> + <return type="Object"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Gets a child node by index (used by editors inheriting from [AnimationRootNode]). + </description> + </method> + <method name="_get_child_nodes" qualifiers="virtual"> + <return type="Dictionary"> + </return> + <description> + Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode]. + </description> + </method> + <method name="_get_parameter_default_value" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="StringName"> + </argument> + <description> + Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. + </description> + </method> + <method name="_get_parameter_list" qualifiers="virtual"> + <return type="Array"> + </return> + <description> + Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. + </description> + </method> + <method name="_has_filter" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. + </description> + </method> + <method name="_process" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="time" type="float"> + </argument> + <argument index="1" name="seek" type="bool"> + </argument> + <description> + User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. + Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. + This function should return the time left for the current animation to finish (if unsure, pass the value from the main blend being called). + </description> + </method> <method name="add_input"> <return type="void"> </return> @@ -77,29 +136,6 @@ Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. </description> </method> - <method name="get_caption" qualifiers="virtual"> - <return type="String"> - </return> - <description> - Gets the text caption for this node (used by some editors). - </description> - </method> - <method name="get_child_by_name" qualifiers="virtual"> - <return type="Object"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - Gets a child node by index (used by editors inheriting from [AnimationRootNode]). - </description> - </method> - <method name="get_child_nodes" qualifiers="virtual"> - <return type="Dictionary"> - </return> - <description> - Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode]. - </description> - </method> <method name="get_input_count" qualifiers="const"> <return type="int"> </return> @@ -125,29 +161,6 @@ Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. </description> </method> - <method name="get_parameter_default_value" qualifiers="virtual"> - <return type="Variant"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> - <description> - Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. - </description> - </method> - <method name="get_parameter_list" qualifiers="virtual"> - <return type="Array"> - </return> - <description> - Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. - </description> - </method> - <method name="has_filter" qualifiers="virtual"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. - </description> - </method> <method name="is_path_filtered" qualifiers="const"> <return type="bool"> </return> @@ -157,19 +170,6 @@ Returns [code]true[/code] whether a given path is filtered. </description> </method> - <method name="process" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="time" type="float"> - </argument> - <argument index="1" name="seek" type="bool"> - </argument> - <description> - User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. - Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. - This function should return the time left for the current animation to finish (if unsure, pass the value from the main blend being called). - </description> - </method> <method name="remove_input"> <return type="void"> </return> diff --git a/doc/classes/AnimationNodeAnimation.xml b/doc/classes/AnimationNodeAnimation.xml index 3f0843c112..75dae6a48e 100644 --- a/doc/classes/AnimationNodeAnimation.xml +++ b/doc/classes/AnimationNodeAnimation.xml @@ -14,7 +14,7 @@ <methods> </methods> <members> - <member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@"""> + <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> </members> diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index 2f0ebd7de6..7f07afecee 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -10,7 +10,7 @@ <methods> </methods> <members> - <member name="advance_condition" type="StringName" setter="set_advance_condition" getter="get_advance_condition" default="@"""> + <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]: [codeblocks] [gdscript] diff --git a/doc/classes/AnimationTrackEditPlugin.xml b/doc/classes/AnimationTrackEditPlugin.xml index 8490d48718..7b96808581 100644 --- a/doc/classes/AnimationTrackEditPlugin.xml +++ b/doc/classes/AnimationTrackEditPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AnimationTrackEditPlugin" inherits="Reference" version="4.0"> +<class name="AnimationTrackEditPlugin" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index f7a116b934..96333988f8 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -54,7 +54,7 @@ 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="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="@"Master""> + <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> <member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus" default="false"> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 108387823b..a2724f3f23 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -52,7 +52,7 @@ 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="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="@"Master""> + <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> <member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus" default="false"> @@ -89,7 +89,7 @@ <member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus" default="false"> If [code]true[/code], the area applies reverb to its associated audio. </member> - <member name="reverb_bus_name" type="StringName" setter="set_reverb_bus" getter="get_reverb_bus" default="@"Master""> + <member name="reverb_bus_name" type="StringName" setter="set_reverb_bus" getter="get_reverb_bus" default="&"Master""> The reverb bus name to use for this area's associated audio. </member> <member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity" default="0.0"> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 49775fa28b..543ec096c7 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -33,8 +33,8 @@ [/gdscript] [csharp] // Array concatenation is not possible with C# arrays, but is with Godot.Collections.Array. - var array1 = new Godot.Collections.Array("One", 2); - var array2 = new Godot.Collections.Array(3, "Four"); + var array1 = new Godot.Collections.Array{"One", 2}; + var array2 = new Godot.Collections.Array{3, "Four"}; GD.Print(array1 + array2); // Prints [One, 2, 3, Four] [/csharp] [/codeblocks] diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 7826932179..f8cbc942e6 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -77,7 +77,6 @@ Creates a new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. The [code]arrays[/code] argument is an array of arrays. See [enum Mesh.ArrayType] for the values used in this array. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used. - Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices. </description> </method> <method name="clear_blend_shapes"> diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml index 3117978d8a..4e924bcb65 100644 --- a/doc/classes/AudioEffectCompressor.xml +++ b/doc/classes/AudioEffectCompressor.xml @@ -32,7 +32,7 @@ <member name="release_ms" type="float" setter="set_release_ms" getter="get_release_ms" default="250.0"> Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000. </member> - <member name="sidechain" type="StringName" setter="set_sidechain" getter="get_sidechain" default="@"""> + <member name="sidechain" type="StringName" setter="set_sidechain" getter="get_sidechain" default="&"""> Reduce the sound level using another audio bus for threshold detection. </member> <member name="threshold" type="float" setter="set_threshold" getter="get_threshold" default="0.0"> diff --git a/doc/classes/AudioEffectInstance.xml b/doc/classes/AudioEffectInstance.xml index dc76880a36..9ab6028901 100644 --- a/doc/classes/AudioEffectInstance.xml +++ b/doc/classes/AudioEffectInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioEffectInstance" inherits="Reference" version="4.0"> +<class name="AudioEffectInstance" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml index da75ff206c..cb01aa75e8 100644 --- a/doc/classes/AudioStreamPlayback.xml +++ b/doc/classes/AudioStreamPlayback.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayback" inherits="Reference" version="4.0"> +<class name="AudioStreamPlayback" inherits="RefCounted" version="4.0"> <brief_description> Meta class for playing back audio. </brief_description> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 113cc64b9d..7c7f7e0cea 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -60,7 +60,7 @@ <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false"> If [code]true[/code], audio plays when added to scene tree. </member> - <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master""> + <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master""> Bus on which this audio is playing. </member> <member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0"> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index e7c276f463..b1e18ab550 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -62,7 +62,7 @@ <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false"> If [code]true[/code], audio plays when added to scene tree. </member> - <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master""> + <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master""> Bus on which this audio is playing. </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0"> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index a1759bd588..3bd20b4b9b 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -69,7 +69,7 @@ <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false"> If [code]true[/code], audio plays when the AudioStreamPlayer3D node is added to scene tree. </member> - <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master""> + <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master""> The bus on which this audio is playing. </member> <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking" default="0"> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 27ead07e6f..83e598d2ba 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -71,6 +71,12 @@ <argument index="1" name="epsilon" type="float" default="2.0"> </argument> <description> + Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices. + To get polygons covering the whole bitmap, pass: + [codeblock] + Rect2(Vector2(), get_size()) + [/codeblock] + [code]epsilon[/code] is passed to RDP to control how accurately the polygons cover the bitmap: a lower [code]epsilon[/code] corresponds to more points in the polygons. </description> </method> <method name="set_bit"> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 30f6c2b951..016eb05308 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -55,10 +55,19 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Returns [code]true[/code] if the given position is behind the camera. + Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. </description> </method> + <method name="is_position_in_frustum" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> + <description> + Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. + </description> + </method> <method name="make_current"> <return type="void"> </return> diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 4fc124592f..fc7dcd3772 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CameraFeed" inherits="Reference" version="4.0"> +<class name="CameraFeed" inherits="RefCounted" version="4.0"> <brief_description> A camera feed gives you access to a single physical camera attached to your device. </brief_description> diff --git a/doc/classes/CharFXTransform.xml b/doc/classes/CharFXTransform.xml index 7b57dc05f8..7a6a18f532 100644 --- a/doc/classes/CharFXTransform.xml +++ b/doc/classes/CharFXTransform.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="CharFXTransform" inherits="Reference" version="4.0"> +<class name="CharFXTransform" inherits="RefCounted" version="4.0"> <brief_description> Controls how an individual character will be displayed in a [RichTextEffect]. </brief_description> diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index c3bb3d28e0..0e6ca073a7 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -101,6 +101,9 @@ <member name="floor_max_angle" type="float" setter="set_floor_max_angle" getter="get_floor_max_angle" default="0.785398"> Maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. The default value equals 45 degrees. </member> + <member name="floor_max_angle_degrees" type="float" setter="set_floor_max_angle_degrees" getter="get_floor_max_angle_degrees" default="45.0"> + Maximum angle (in degrees) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. + </member> <member name="infinite_inertia" type="bool" setter="set_infinite_inertia_enabled" getter="is_infinite_inertia_enabled" default="true"> If [code]true[/code], the body will be able to push [RigidBody2D] nodes when calling [method move_and_slide], but it also won't detect any collisions with them. If [code]false[/code], it will interact with [RigidBody2D] nodes like with [StaticBody2D]. </member> diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 986874df3b..790edfcad1 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -87,6 +87,9 @@ <member name="floor_max_angle" type="float" setter="set_floor_max_angle" getter="get_floor_max_angle" default="0.785398"> Maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. The default value equals 45 degrees. </member> + <member name="floor_max_angle_degrees" type="float" setter="set_floor_max_angle_degrees" getter="get_floor_max_angle_degrees" default="45.0"> + Maximum angle (in degrees) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. + </member> <member name="infinite_inertia" type="bool" setter="set_infinite_inertia_enabled" getter="is_infinite_inertia_enabled" default="true"> If [code]true[/code], the body will be able to push [RigidBody3D] nodes when calling [method move_and_slide], but it also won't detect any collisions with them. If [code]false[/code], it will interact with [RigidBody3D] nodes like with [StaticBody3D]. </member> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index 38948a2d6e..8b903d8dbc 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ConfigFile" inherits="Reference" version="4.0"> +<class name="ConfigFile" inherits="RefCounted" version="4.0"> <brief_description> Helper class to handle INI-style files. </brief_description> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 12344712a0..33969cf4c3 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -22,6 +22,34 @@ <link title="All GUI Demos">https://github.com/godotengine/godot-demo-projects/tree/master/gui</link> </tutorials> <methods> + <method name="_can_drop_data" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. + This method should only be used to test the data. Process the data in [method _drop_data]. + [codeblocks] + [gdscript] + func _can_drop_data(position, data): + # Check position if it is relevant to you + # Otherwise, just check data + return typeof(data) == TYPE_DICTIONARY and data.has("expected") + [/gdscript] + [csharp] + public override bool CanDropData(Vector2 position, object data) + { + // Check position if it is relevant to you + // Otherwise, just check data + return data is Godot.Collections.Dictionary && (data as Godot.Collections.Dictionary).Contains("expected"); + } + [/csharp] + [/codeblocks] + </description> + </method> <method name="_clips_input" qualifiers="virtual"> <return type="bool"> </return> @@ -30,6 +58,61 @@ If not overridden, defaults to [code]false[/code]. </description> </method> + <method name="_drop_data" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. + [codeblocks] + [gdscript] + func _can_drop_data(position, data): + return typeof(data) == TYPE_DICTIONARY and data.has("color") + func _drop_data(position, data): + var color = data["color"] + [/gdscript] + [csharp] + public override bool CanDropData(Vector2 position, object data) + { + return data is Godot.Collections.Dictionary && (data as Godot.Collections.Dictionary).Contains("color"); + } + public override void DropData(Vector2 position, object data) + { + Color color = (Color)(data as Godot.Collections.Dictionary)["color"]; + } + [/csharp] + [/codeblocks] + </description> + </method> + <method name="_get_drag_data" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. + A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. + [codeblocks] + [gdscript] + func _get_drag_data(position): + var mydata = make_data() # This is your custom method generating the drag data. + set_drag_preview(make_preview(mydata)) # This is your custom method generating the preview of the drag data. + return mydata + [/gdscript] + [csharp] + public override object GetDragData(Vector2 position) + { + object mydata = MakeData(); // This is your custom method generating the drag data. + SetDragPreview(MakePreview(mydata)); // This is your custom method generating the preview of the drag data. + return mydata; + } + [/csharp] + [/codeblocks] + </description> + </method> <method name="_get_minimum_size" qualifiers="virtual"> <return type="Vector2"> </return> @@ -68,13 +151,24 @@ [/csharp] [/codeblocks] The event won't trigger if: - * clicking outside the control (see [method has_point]); + * clicking outside the control (see [method _has_point]); * control has [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE]; * control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE]; * control's parent has [member mouse_filter] set to [constant MOUSE_FILTER_STOP] or has accepted the event; * it happens outside parent's rectangle and the parent has either [member rect_clip_content] or [method _clips_input] enabled. </description> </method> + <method name="_has_point" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. + If not overridden, default behavior is checking if the point is within control's Rect. + [b]Note:[/b] If you want to check if a point is inside the control, you can use [code]get_rect().has_point(point)[/code]. + </description> + </method> <method name="_make_custom_tooltip" qualifiers="virtual"> <return type="Control"> </return> @@ -249,63 +343,6 @@ [/codeblocks] </description> </method> - <method name="can_drop_data" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <description> - Godot calls this method to test if [code]data[/code] from a control's [method get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. - This method should only be used to test the data. Process the data in [method drop_data]. - [codeblocks] - [gdscript] - func can_drop_data(position, data): - # Check position if it is relevant to you - # Otherwise, just check data - return typeof(data) == TYPE_DICTIONARY and data.has("expected") - [/gdscript] - [csharp] - public override bool CanDropData(Vector2 position, object data) - { - // Check position if it is relevant to you - // Otherwise, just check data - return data is Godot.Collections.Dictionary && (data as Godot.Collections.Dictionary).Contains("expected"); - } - [/csharp] - [/codeblocks] - </description> - </method> - <method name="drop_data" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <description> - Godot calls this method to pass you the [code]data[/code] from a control's [method get_drag_data] result. Godot first calls [method can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. - [codeblocks] - [gdscript] - func can_drop_data(position, data): - return typeof(data) == TYPE_DICTIONARY and data.has("color") - func drop_data(position, data): - var color = data["color"] - [/gdscript] - [csharp] - public override bool CanDropData(Vector2 position, object data) - { - return data is Godot.Collections.Dictionary && (data as Godot.Collections.Dictionary).Contains("color"); - } - public override void DropData(Vector2 position, object data) - { - Color color = (Color)(data as Godot.Collections.Dictionary)["color"]; - } - [/csharp] - [/codeblocks] - </description> - </method> <method name="find_next_valid_focus" qualifiers="const"> <return type="Control"> </return> @@ -328,8 +365,8 @@ <argument index="1" name="preview" type="Control"> </argument> <description> - Forces drag and bypasses [method get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. - The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data. + Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. + The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data. </description> </method> <method name="get_anchor" qualifiers="const"> @@ -364,32 +401,6 @@ Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. </description> </method> - <method name="get_drag_data" qualifiers="virtual"> - <return type="Variant"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <description> - Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. - A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. - [codeblocks] - [gdscript] - func get_drag_data(position): - var mydata = make_data() # This is your custom method generating the drag data. - set_drag_preview(make_preview(mydata)) # This is your custom method generating the preview of the drag data. - return mydata - [/gdscript] - [csharp] - public override object GetDragData(Vector2 position) - { - object mydata = MakeData(); // This is your custom method generating the drag data. - SetDragPreview(MakePreview(mydata)); // This is your custom method generating the preview of the drag data. - return mydata; - } - [/csharp] - [/codeblocks] - </description> - </method> <method name="get_end" qualifiers="const"> <return type="Vector2"> </return> @@ -577,17 +588,6 @@ Returns [code]true[/code] if this is the current focused control. See [member focus_mode]. </description> </method> - <method name="has_point" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2"> - </argument> - <description> - Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. - If not overridden, default behavior is checking if the point is within control's Rect. - [b]Note:[/b] If you want to check if a point is inside the control, you can use [code]get_rect().has_point(point)[/code]. - </description> - </method> <method name="has_theme_color" qualifiers="const"> <return type="bool"> </return> @@ -856,7 +856,7 @@ </argument> <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: + 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: 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] @@ -871,13 +871,13 @@ # TargetControl.gd extends Control - func can_drop_data_fw(position, data, from_control): + func _can_drop_data_fw(position, data, from_control): return true - func drop_data_fw(position, data, from_control): + func _drop_data_fw(position, data, from_control): my_handle_data(data) # Your handler method. - func get_drag_data_fw(position, from_control): + func _get_drag_data_fw(position, from_control): set_drag_preview(my_preview) return my_data() [/gdscript] @@ -922,12 +922,12 @@ <argument index="0" name="control" type="Control"> </argument> <description> - Shows the given control at the mouse pointer. A good time to call this method is in [method get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. + Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. [codeblocks] [gdscript] export (Color, RGBA) var color = Color(1, 0, 0, 1) - func get_drag_data(position): + func _get_drag_data(position): # Use a control that is not in the tree var cpb = ColorPickerButton.new() cpb.color = color @@ -1175,7 +1175,7 @@ <member name="theme" type="Theme" setter="set_theme" getter="get_theme"> The [Theme] resource this node and all its [Control] children use. If a child node has its own [Theme] resource set, theme items are merged with child's definitions having higher priority. </member> - <member name="theme_custom_type" type="StringName" setter="set_theme_custom_type" getter="get_theme_custom_type" default="@"""> + <member name="theme_custom_type" type="StringName" setter="set_theme_custom_type" getter="get_theme_custom_type" default="&"""> The type name used by this [Control] to look up its own theme items. By default, the class name of the node is used (e.g. [code]Button[/code] for the [Button] control), as well as the class names of all parent classes (in order of inheritance). Setting this property gives the highest priority to the type of the specified name, then falls back on the class names. [b]Note:[/b] To look up [Control]'s own items use various [code]get_theme_*[/code] methods without specifying [code]theme_type[/code]. [b]Note:[/b] Theme items are looked for in the tree order, from branch to root, where each [Control] node is checked for its [member theme] property. The earliest match against any type/class name is returned. The project-level Theme and the default Theme are checked last. diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index 1f6cb40cde..deda6116f4 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Crypto" inherits="Reference" version="4.0"> +<class name="Crypto" inherits="RefCounted" version="4.0"> <brief_description> Access to advanced cryptographic functionalities. </brief_description> diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index 91a04b1f28..28d68d309f 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="DTLSServer" inherits="Reference" version="4.0"> +<class name="DTLSServer" inherits="RefCounted" version="4.0"> <brief_description> Helper class to implement a DTLS server. </brief_description> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 2c61d723cd..dae8d83f0c 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Directory" inherits="Reference" version="4.0"> +<class name="Directory" inherits="RefCounted" version="4.0"> <brief_description> Type used to handle the filesystem. </brief_description> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index b29734de1c..d9e3003fbb 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorExportPlugin" inherits="Reference" version="4.0"> +<class name="EditorExportPlugin" inherits="RefCounted" version="4.0"> <brief_description> A script that is executed when exporting the project. </brief_description> diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index e05a685dd7..0cd839f370 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorFeatureProfile" inherits="Reference" version="4.0"> +<class name="EditorFeatureProfile" inherits="RefCounted" version="4.0"> <brief_description> An editor feature profile which can be used to disable specific features. </brief_description> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 663eb0ff5c..a532e9bc2b 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -5,45 +5,45 @@ </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. + 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. Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec": [codeblocks] [gdscript] tool extends EditorImportPlugin - func get_importer_name(): + func _get_importer_name(): return "my.special.plugin" - func get_visible_name(): + func _get_visible_name(): return "Special Mesh" - func get_recognized_extensions(): + func _get_recognized_extensions(): return ["special", "spec"] - func get_save_extension(): + func _get_save_extension(): return "mesh" - func get_resource_type(): + func _get_resource_type(): return "Mesh" - func get_preset_count(): + func _get_preset_count(): return 1 - func get_preset_name(i): + func _get_preset_name(i): return "Default" - func get_import_options(i): + func _get_import_options(i): return [{"name": "my_option", "default_value": false}] - func import(source_file, save_path, options, platform_variants, gen_files): + func _import(source_file, save_path, options, platform_variants, gen_files): var file = File.new() if file.open(source_file, File.READ) != OK: return FAILED var mesh = ArrayMesh.new() # Fill the Mesh with data read in "file", left as an exercise to the reader. - var filename = save_path + "." + get_save_extension() + var filename = save_path + "." + _get_save_extension() return ResourceSaver.save(filename, mesh) [/gdscript] [csharp] @@ -113,7 +113,7 @@ <link title="Import plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/import_plugins.html</link> </tutorials> <methods> - <method name="get_import_options" qualifiers="virtual"> + <method name="_get_import_options" qualifiers="virtual"> <return type="Array"> </return> <argument index="0" name="preset" type="int"> @@ -122,21 +122,21 @@ 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> </method> - <method name="get_import_order" qualifiers="virtual"> + <method name="_get_import_order" qualifiers="virtual"> <return type="int"> </return> <description> Gets the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. </description> </method> - <method name="get_importer_name" qualifiers="virtual"> + <method name="_get_importer_name" qualifiers="virtual"> <return type="String"> </return> <description> Gets the unique name of the importer. </description> </method> - <method name="get_option_visibility" qualifiers="virtual"> + <method name="_get_option_visibility" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="option" type="String"> @@ -147,7 +147,7 @@ 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] [gdscript] - func get_option_visibility(option, options): + func _get_option_visibility(option, options): # Only show the lossy quality setting if the compression mode is set to "Lossy". if option == "compress/lossy_quality" and options.has("compress/mode"): return int(options["compress/mode"]) == COMPRESS_LOSSY # This is a constant that you set @@ -170,14 +170,14 @@ Return [code]true[/code] to make all options always visible. </description> </method> - <method name="get_preset_count" qualifiers="virtual"> + <method name="_get_preset_count" qualifiers="virtual"> <return type="int"> </return> <description> - Gets the number of initial presets defined by the plugin. Use [method get_import_options] to get the default options for the preset and [method get_preset_name] to get the name of the preset. + Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset. </description> </method> - <method name="get_preset_name" qualifiers="virtual"> + <method name="_get_preset_name" qualifiers="virtual"> <return type="String"> </return> <argument index="0" name="preset" type="int"> @@ -186,42 +186,42 @@ Gets the name of the options preset at this index. </description> </method> - <method name="get_priority" qualifiers="virtual"> + <method name="_get_priority" qualifiers="virtual"> <return type="float"> </return> <description> Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code]. </description> </method> - <method name="get_recognized_extensions" qualifiers="virtual"> + <method name="_get_recognized_extensions" qualifiers="virtual"> <return type="Array"> </return> <description> Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code]. </description> </method> - <method name="get_resource_type" qualifiers="virtual"> + <method name="_get_resource_type" qualifiers="virtual"> <return type="String"> </return> <description> Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code]. </description> </method> - <method name="get_save_extension" qualifiers="virtual"> + <method name="_get_save_extension" qualifiers="virtual"> <return type="String"> </return> <description> Gets the extension used to save this resource in the [code].godot/imported[/code] directory. </description> </method> - <method name="get_visible_name" qualifiers="virtual"> + <method name="_get_visible_name" qualifiers="virtual"> <return type="String"> </return> <description> Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". </description> </method> - <method name="import" qualifiers="virtual"> + <method name="_import" qualifiers="virtual"> <return type="int"> </return> <argument index="0" name="source_file" type="String"> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 8204dc931e..c992d0fbb4 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -1,106 +1,100 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorInspectorPlugin" inherits="Reference" version="4.0"> +<class name="EditorInspectorPlugin" inherits="RefCounted" version="4.0"> <brief_description> 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]. - 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. + 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. </description> <tutorials> </tutorials> <methods> - <method name="add_custom_control"> - <return type="void"> + <method name="_can_handle" qualifiers="virtual"> + <return type="bool"> </return> - <argument index="0" name="control" type="Control"> + <argument index="0" name="object" type="Object"> </argument> <description> - Adds a custom control, not necessarily a property editor. + Returns [code]true[/code] if this object can be handled by this plugin. </description> </method> - <method name="add_property_editor"> + <method name="_parse_begin" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="property" type="String"> - </argument> - <argument index="1" name="editor" type="Control"> - </argument> <description> - Adds a property editor, this must inherit [EditorProperty]. + Called to allow adding controls at the beginning of the list. </description> </method> - <method name="add_property_editor_for_multiple_properties"> + <method name="_parse_category" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="properties" type="PackedStringArray"> - </argument> - <argument index="2" name="editor" type="Control"> + <argument index="0" name="category" type="String"> </argument> <description> - Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. + Called to allow adding controls at the beginning of the category. </description> </method> - <method name="can_handle" qualifiers="virtual"> - <return type="bool"> + <method name="_parse_end" qualifiers="virtual"> + <return type="void"> </return> - <argument index="0" name="object" type="Object"> - </argument> <description> - Returns [code]true[/code] if this object can be handled by this plugin. + Called to allow adding controls at the end of the list. </description> </method> - <method name="parse_begin" qualifiers="virtual"> - <return type="void"> + <method name="_parse_property" qualifiers="virtual"> + <return type="bool"> </return> - <argument index="0" name="object" type="Object"> + <argument index="0" name="type" type="int"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <argument index="2" name="hint" type="int"> + </argument> + <argument index="3" name="hint_text" type="String"> + </argument> + <argument index="4" name="usage" type="int"> </argument> <description> - Called to allow adding controls at the beginning of the list. + 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. </description> </method> - <method name="parse_category" qualifiers="virtual"> + <method name="add_custom_control"> <return type="void"> </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="category" type="String"> + <argument index="0" name="control" type="Control"> </argument> <description> - Called to allow adding controls at the beginning of the category. + Adds a custom control, not necessarily a property editor. </description> </method> - <method name="parse_end" qualifiers="virtual"> + <method name="add_property_editor"> <return type="void"> </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="editor" type="Control"> + </argument> <description> - Called to allow adding controls at the end of the list. + Adds a property editor, this must inherit [EditorProperty]. </description> </method> - <method name="parse_property" qualifiers="virtual"> - <return type="bool"> + <method name="add_property_editor_for_multiple_properties"> + <return type="void"> </return> - <argument index="0" name="object" type="Object"> - </argument> - <argument index="1" name="type" type="int"> - </argument> - <argument index="2" name="path" type="String"> - </argument> - <argument index="3" name="hint" type="int"> + <argument index="0" name="label" type="String"> </argument> - <argument index="4" name="hint_text" type="String"> + <argument index="1" name="properties" type="PackedStringArray"> </argument> - <argument index="5" name="usage" type="int"> + <argument index="2" name="editor" type="Control"> </argument> <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. + Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. </description> </method> </methods> diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml index 45541b9263..dcc6d6ef12 100644 --- a/doc/classes/EditorNode3DGizmo.xml +++ b/doc/classes/EditorNode3DGizmo.xml @@ -9,13 +9,76 @@ <tutorials> </tutorials> <methods> + <method name="_commit_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="restore" type="Variant"> + </argument> + <argument index="2" name="cancel" type="bool" default="false"> + </argument> + <description> + Commit a handle being edited (handles must have been previously added by [method add_handles]). + If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided. + </description> + </method> + <method name="_get_handle_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Gets the name of an edited handle (handles must have been previously added by [method add_handles]). + Handles can be named for reference to the user when editing. + </description> + </method> + <method name="_get_handle_value" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method _commit_handle]. + </description> + </method> + <method name="_is_handle_highlighted" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Returns [code]true[/code] if the handle at index [code]index[/code] is highlighted by being hovered with the mouse. + </description> + </method> + <method name="_redraw" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This function is called when the [Node3D] this gizmo refers to changes (the [method Node3D.update_gizmo] is called). + </description> + </method> + <method name="_set_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="camera" type="Camera3D"> + </argument> + <argument index="2" name="point" type="Vector2"> + </argument> + <description> + This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. + The [Camera3D] is also provided so screen coordinates can be converted to raycasts. + </description> + </method> <method name="add_collision_segments"> <return type="void"> </return> <argument index="0" name="segments" type="PackedVector3Array"> </argument> <description> - Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method redraw]. + Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method _redraw]. </description> </method> <method name="add_collision_triangles"> @@ -24,7 +87,7 @@ <argument index="0" name="triangles" type="TriangleMesh"> </argument> <description> - Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. + Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method _redraw]. </description> </method> <method name="add_handles"> @@ -40,7 +103,7 @@ </argument> <description> Adds a list of handles (points) which can be used to deform the object being edited. - There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw]. + There are virtual functions which will be called upon editing of these handles. Call this function during [method _redraw]. </description> </method> <method name="add_lines"> @@ -55,7 +118,7 @@ <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> - Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. + Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method _redraw]. </description> </method> <method name="add_mesh"> @@ -70,7 +133,7 @@ <argument index="3" name="material" type="Material" default="null"> </argument> <description> - Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method redraw]. + Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method _redraw]. </description> </method> <method name="add_unscaled_billboard"> @@ -83,7 +146,7 @@ <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> </argument> <description> - Adds an unscaled billboard for visualization. Call this function during [method redraw]. + Adds an unscaled billboard for visualization. Call this function during [method _redraw]. </description> </method> <method name="clear"> @@ -93,39 +156,6 @@ Removes everything in the gizmo including meshes, collisions and handles. </description> </method> - <method name="commit_handle" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <argument index="1" name="restore" type="Variant"> - </argument> - <argument index="2" name="cancel" type="bool" default="false"> - </argument> - <description> - Commit a handle being edited (handles must have been previously added by [method add_handles]). - If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided. - </description> - </method> - <method name="get_handle_name" qualifiers="virtual"> - <return type="String"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - Gets the name of an edited handle (handles must have been previously added by [method add_handles]). - Handles can be named for reference to the user when editing. - </description> - </method> - <method name="get_handle_value" qualifiers="virtual"> - <return type="Variant"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]. - </description> - </method> <method name="get_plugin" qualifiers="const"> <return type="EditorNode3DGizmoPlugin"> </return> @@ -140,36 +170,6 @@ Returns the Node3D node associated with this gizmo. </description> </method> - <method name="is_handle_highlighted" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - Returns [code]true[/code] if the handle at index [code]index[/code] is highlighted by being hovered with the mouse. - </description> - </method> - <method name="redraw" qualifiers="virtual"> - <return type="void"> - </return> - <description> - This function is called when the [Node3D] this gizmo refers to changes (the [method Node3D.update_gizmo] is called). - </description> - </method> - <method name="set_handle" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <argument index="1" name="camera" type="Camera3D"> - </argument> - <argument index="2" name="point" type="Vector2"> - </argument> - <description> - This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. - The [Camera3D] is also provided so screen coordinates can be converted to raycasts. - </description> - </method> <method name="set_hidden"> <return type="void"> </return> diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index 34657a1c08..5551326533 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -10,25 +10,14 @@ <link title="Spatial gizmo plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/spatial_gizmos.html</link> </tutorials> <methods> - <method name="add_material"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="material" type="StandardMaterial3D"> - </argument> - <description> - Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. - </description> - </method> - <method name="can_be_hidden" qualifiers="virtual"> + <method name="_can_be_hidden" qualifiers="virtual"> <return type="bool"> </return> <description> Override this method to define whether the gizmo can be hidden or not. Returns [code]true[/code] if not overridden. </description> </method> - <method name="commit_handle" qualifiers="virtual"> + <method name="_commit_handle" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -43,69 +32,23 @@ Override this method to commit gizmo handles. Called for this plugin's active gizmos. </description> </method> - <method name="create_gizmo" qualifiers="virtual"> + <method name="_create_gizmo" qualifiers="virtual"> <return type="EditorNode3DGizmo"> </return> <argument index="0" name="spatial" type="Node3D"> </argument> <description> - Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method has_gizmo]. - </description> - </method> - <method name="create_handle_material"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="billboard" type="bool" default="false"> - </argument> - <argument index="2" name="texture" type="Texture2D" default="null"> - </argument> - <description> - Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. - You can optionally provide a texture to use instead of the default icon. - </description> - </method> - <method name="create_icon_material"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="texture" type="Texture2D"> - </argument> - <argument index="2" name="on_top" type="bool" default="false"> - </argument> - <argument index="3" name="color" type="Color" default="Color( 1, 1, 1, 1 )"> - </argument> - <description> - Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. - </description> - </method> - <method name="create_material"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <argument index="2" name="billboard" type="bool" default="false"> - </argument> - <argument index="3" name="on_top" type="bool" default="false"> - </argument> - <argument index="4" name="use_vertex_color" type="bool" default="false"> - </argument> - <description> - Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. + Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method _has_gizmo]. </description> </method> - <method name="get_gizmo_name" qualifiers="virtual"> + <method name="_get_gizmo_name" qualifiers="virtual"> <return type="String"> </return> <description> Override this method to provide the name that will appear in the gizmo visibility menu. </description> </method> - <method name="get_handle_name" qualifiers="virtual"> + <method name="_get_handle_name" qualifiers="virtual"> <return type="String"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -116,7 +59,7 @@ Override this method to provide gizmo's handle names. Called for this plugin's active gizmos. </description> </method> - <method name="get_handle_value" qualifiers="virtual"> + <method name="_get_handle_value" qualifiers="virtual"> <return type="Variant"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -127,18 +70,7 @@ Gets actual value of a handle from gizmo. Called for this plugin's active gizmos. </description> </method> - <method name="get_material"> - <return type="StandardMaterial3D"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="gizmo" type="EditorNode3DGizmo" default="null"> - </argument> - <description> - Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). - </description> - </method> - <method name="get_priority" qualifiers="virtual"> + <method name="_get_priority" qualifiers="virtual"> <return type="int"> </return> <description> @@ -146,7 +78,7 @@ All built-in editor gizmos return a priority of [code]-1[/code]. If not overridden, this method will return [code]0[/code], which means custom gizmos will automatically override built-in gizmos. </description> </method> - <method name="has_gizmo" qualifiers="virtual"> + <method name="_has_gizmo" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="spatial" type="Node3D"> @@ -155,7 +87,7 @@ Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos. </description> </method> - <method name="is_handle_highlighted" qualifiers="virtual"> + <method name="_is_handle_highlighted" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -166,14 +98,14 @@ Gets whether a handle is highlighted or not. Called for this plugin's active gizmos. </description> </method> - <method name="is_selectable_when_hidden" qualifiers="virtual"> + <method name="_is_selectable_when_hidden" qualifiers="virtual"> <return type="bool"> </return> <description> Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden. </description> </method> - <method name="redraw" qualifiers="virtual"> + <method name="_redraw" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -182,7 +114,7 @@ Callback to redraw the provided gizmo. Called for this plugin's active gizmos. </description> </method> - <method name="set_handle" qualifiers="virtual"> + <method name="_set_handle" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="gizmo" type="EditorNode3DGizmo"> @@ -197,6 +129,74 @@ Update the value of a handle after it has been updated. Called for this plugin's active gizmos. </description> </method> + <method name="add_material"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="material" type="StandardMaterial3D"> + </argument> + <description> + Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. + </description> + </method> + <method name="create_handle_material"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="billboard" type="bool" default="false"> + </argument> + <argument index="2" name="texture" type="Texture2D" default="null"> + </argument> + <description> + Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. + You can optionally provide a texture to use instead of the default icon. + </description> + </method> + <method name="create_icon_material"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="texture" type="Texture2D"> + </argument> + <argument index="2" name="on_top" type="bool" default="false"> + </argument> + <argument index="3" name="color" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. + </description> + </method> + <method name="create_material"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <argument index="3" name="on_top" type="bool" default="false"> + </argument> + <argument index="4" name="use_vertex_color" type="bool" default="false"> + </argument> + <description> + Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. + </description> + </method> + <method name="get_material"> + <return type="StandardMaterial3D"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="gizmo" type="EditorNode3DGizmo" default="null"> + </argument> + <description> + Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). + </description> + </method> </methods> <constants> </constants> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 6c40b7aa9d..0c0439e9d3 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -10,185 +10,7 @@ <link title="Editor plugins tutorial index">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html</link> </tutorials> <methods> - <method name="add_autoload_singleton"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="path" type="String"> - </argument> - <description> - Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. - </description> - </method> - <method name="add_control_to_bottom_panel"> - <return type="Button"> - </return> - <argument index="0" name="control" type="Control"> - </argument> - <argument index="1" name="title" type="String"> - </argument> - <description> - Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. - </description> - </method> - <method name="add_control_to_container"> - <return type="void"> - </return> - <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> - </argument> - <argument index="1" name="control" type="Control"> - </argument> - <description> - Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. - Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). - When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [method Node.queue_free]. - </description> - </method> - <method name="add_control_to_dock"> - <return type="void"> - </return> - <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot"> - </argument> - <argument index="1" name="control" type="Control"> - </argument> - <description> - Adds the control to a specific dock slot (see [enum DockSlot] for options). - If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. - When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free]. - </description> - </method> - <method name="add_custom_type"> - <return type="void"> - </return> - <argument index="0" name="type" type="String"> - </argument> - <argument index="1" name="base" type="String"> - </argument> - <argument index="2" name="script" type="Script"> - </argument> - <argument index="3" name="icon" type="Texture2D"> - </argument> - <description> - Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. - When given node or resource is selected, the base type will be instanced (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. - You can use the virtual method [method handles] to check if your custom object is being edited by checking the script or using the [code]is[/code] keyword. - During run-time, this will be a simple object with a script so this function does not need to be called then. - </description> - </method> - <method name="add_debugger_plugin"> - <return type="void"> - </return> - <argument index="0" name="script" type="Script"> - </argument> - <description> - Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. - </description> - </method> - <method name="add_export_plugin"> - <return type="void"> - </return> - <argument index="0" name="plugin" type="EditorExportPlugin"> - </argument> - <description> - Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. - See [method add_inspector_plugin] for an example of how to register a plugin. - </description> - </method> - <method name="add_import_plugin"> - <return type="void"> - </return> - <argument index="0" name="importer" type="EditorImportPlugin"> - </argument> - <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. - See [method add_inspector_plugin] for an example of how to register a plugin. - </description> - </method> - <method name="add_inspector_plugin"> - <return type="void"> - </return> - <argument index="0" name="plugin" type="EditorInspectorPlugin"> - </argument> - <description> - Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. - [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. - [codeblocks] - [gdscript] - const MyInspectorPlugin = preload("res://addons/your_addon/path/to/your/script.gd") - var inspector_plugin = MyInspectorPlugin.new() - - func _enter_tree(): - add_inspector_plugin(inspector_plugin) - - func _exit_tree(): - remove_inspector_plugin(inspector_plugin) - [/gdscript] - [/codeblocks] - </description> - </method> - <method name="add_scene_import_plugin"> - <return type="void"> - </return> - <argument index="0" name="scene_importer" type="EditorSceneImporter"> - </argument> - <description> - Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. - </description> - </method> - <method name="add_spatial_gizmo_plugin"> - <return type="void"> - </return> - <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin"> - </argument> - <description> - Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. - See [method add_inspector_plugin] for an example of how to register a plugin. - </description> - </method> - <method name="add_tool_menu_item"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="callable" type="Callable"> - </argument> - <description> - Adds a custom menu item to [b]Project > Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called. - </description> - </method> - <method name="add_tool_submenu_item"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="submenu" type="Object"> - </argument> - <description> - Adds a custom submenu under [b]Project > Tools >[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. - </description> - </method> - <method name="add_translation_parser_plugin"> - <return type="void"> - </return> - <argument index="0" name="parser" type="EditorTranslationParserPlugin"> - </argument> - <description> - Registers a custom translation parser plugin for extracting translatable strings from custom files. - </description> - </method> - <method name="add_undo_redo_inspector_hook_callback"> - <return type="void"> - </return> - <argument index="0" name="callable" type="Callable"> - </argument> - <description> - Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. - The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. - </description> - </method> - <method name="apply_changes" qualifiers="virtual"> + <method name="_apply_changes" qualifiers="virtual"> <return type="void"> </return> <description> @@ -196,29 +18,29 @@ This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. </description> </method> - <method name="build" qualifiers="virtual"> + <method name="_build" qualifiers="virtual"> <return type="bool"> </return> <description> This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. - This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method build] methods from running. + This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method _build] methods from running. </description> </method> - <method name="clear" qualifiers="virtual"> + <method name="_clear" qualifiers="virtual"> <return type="void"> </return> <description> Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. </description> </method> - <method name="disable_plugin" qualifiers="virtual"> + <method name="_disable_plugin" qualifiers="virtual"> <return type="void"> </return> <description> Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window. </description> </method> - <method name="edit" qualifiers="virtual"> + <method name="_edit" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="object" type="Object"> @@ -227,14 +49,14 @@ This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. </description> </method> - <method name="enable_plugin" qualifiers="virtual"> + <method name="_enable_plugin" qualifiers="virtual"> <return type="void"> </return> <description> Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window. </description> </method> - <method name="forward_canvas_draw_over_viewport" qualifiers="virtual"> + <method name="_forward_canvas_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="overlay" type="Control"> @@ -243,11 +65,11 @@ Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] [gdscript] - func forward_canvas_draw_over_viewport(overlay): + func _forward_canvas_draw_over_viewport(overlay): # Draw a circle at cursor position. overlay.draw_circle(overlay.get_local_mouse_position(), 64, Color.white) - func forward_canvas_gui_input(event): + func _forward_canvas_gui_input(event): if event is InputEventMouseMotion: # Redraw viewport when cursor is moved. update_overlays() @@ -274,27 +96,27 @@ [/codeblocks] </description> </method> - <method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual"> + <method name="_forward_canvas_force_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="overlay" type="Control"> </argument> <description> - This method is the same as [method forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. + This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. </description> </method> - <method name="forward_canvas_gui_input" qualifiers="virtual"> + <method name="_forward_canvas_gui_input" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="event" type="InputEvent"> </argument> <description> - 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: + 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 - func forward_canvas_gui_input(event): + func _forward_canvas_gui_input(event): return true [/gdscript] [csharp] @@ -309,7 +131,7 @@ [codeblocks] [gdscript] # Consumes InputEventMouseMotion and forwards other InputEvent types. - func forward_canvas_gui_input(event): + func _forward_canvas_gui_input(event): return event is InputEventMouseMotion [/gdscript] [csharp] @@ -322,7 +144,7 @@ [/codeblocks] </description> </method> - <method name="forward_spatial_draw_over_viewport" qualifiers="virtual"> + <method name="_forward_spatial_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="overlay" type="Control"> @@ -331,11 +153,11 @@ Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblocks] [gdscript] - func forward_spatial_draw_over_viewport(overlay): + func _forward_spatial_draw_over_viewport(overlay): # Draw a circle at cursor position. overlay.draw_circle(overlay.get_local_mouse_position(), 64) - func forward_spatial_gui_input(camera, event): + func _forward_spatial_gui_input(camera, event): if event is InputEventMouseMotion: # Redraw viewport when cursor is moved. update_overlays() @@ -362,17 +184,17 @@ [/codeblocks] </description> </method> - <method name="forward_spatial_force_draw_over_viewport" qualifiers="virtual"> + <method name="_forward_spatial_force_draw_over_viewport" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="overlay" type="Control"> </argument> <description> - This method is the same as [method forward_spatial_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. + This method is the same as [method _forward_spatial_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. </description> </method> - <method name="forward_spatial_gui_input" qualifiers="virtual"> + <method name="_forward_spatial_gui_input" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="camera" type="Camera3D"> @@ -380,11 +202,11 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Called when there is a root node in the current edited scene, [method handles] is implemented and an [InputEvent] happens in the 3D 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: + Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 3D 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. - func forward_spatial_gui_input(camera, event): + func _forward_spatial_gui_input(camera, event): return true [/gdscript] [csharp] @@ -399,7 +221,7 @@ [codeblocks] [gdscript] # Consumes InputEventMouseMotion and forwards other InputEvent types. - func forward_spatial_gui_input(camera, event): + func _forward_spatial_gui_input(camera, event): return event is InputEventMouseMotion [/gdscript] [csharp] @@ -412,21 +234,14 @@ [/codeblocks] </description> </method> - <method name="get_breakpoints" qualifiers="virtual"> + <method name="_get_breakpoints" qualifiers="virtual"> <return type="PackedStringArray"> </return> <description> This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code]. </description> </method> - <method name="get_editor_interface"> - <return type="EditorInterface"> - </return> - <description> - Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. - </description> - </method> - <method name="get_plugin_icon" qualifiers="virtual"> + <method name="_get_plugin_icon" qualifiers="virtual"> <return type="Texture2D"> </return> <description> @@ -435,7 +250,7 @@ Ideally, the plugin icon should be white with a transparent background and 16x16 pixels in size. [codeblocks] [gdscript] - func get_plugin_icon(): + func _get_plugin_icon(): # You can use a custom icon: return preload("res://addons/my_plugin/my_plugin_icon.svg") # Or use a built-in icon: @@ -453,7 +268,7 @@ [/codeblocks] </description> </method> - <method name="get_plugin_name" qualifiers="virtual"> + <method name="_get_plugin_name" qualifiers="virtual"> <return type="String"> </return> <description> @@ -461,75 +276,285 @@ For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. </description> </method> - <method name="get_script_create_dialog"> - <return type="ScriptCreateDialog"> + <method name="_get_state" qualifiers="virtual"> + <return type="Dictionary"> </return> <description> - Gets the Editor's dialogue used for making scripts. - [b]Note:[/b] Users can configure it before use. + Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). </description> </method> - <method name="get_state" qualifiers="virtual"> - <return type="Dictionary"> + <method name="_get_window_layout" qualifiers="virtual"> + <return type="void"> </return> + <argument index="0" name="layout" type="ConfigFile"> + </argument> <description> - Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). + Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). </description> </method> - <method name="get_undo_redo"> - <return type="UndoRedo"> + <method name="_handles" qualifiers="virtual"> + <return type="bool"> </return> + <argument index="0" name="object" type="Object"> + </argument> <description> - Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_spatial_gui_input] these will be called too. + </description> + </method> + <method name="_has_main_screen" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). + </description> + </method> + <method name="_make_visible" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. + Remember that you have to manage the visibility of all your editor controls manually. + </description> + </method> + <method name="_save_external_data" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. + </description> + </method> + <method name="_set_state" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="state" type="Dictionary"> + </argument> + <description> + Restore the state saved by [method _get_state]. </description> </method> - <method name="get_window_layout" qualifiers="virtual"> + <method name="_set_window_layout" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="layout" type="ConfigFile"> </argument> <description> - Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). + Restore the plugin GUI layout saved by [method _get_window_layout]. </description> </method> - <method name="handles" qualifiers="virtual"> - <return type="bool"> + <method name="add_autoload_singleton"> + <return type="void"> </return> - <argument index="0" name="object" type="Object"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="path" type="String"> </argument> <description> - Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method edit] and [method make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too. + Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. </description> </method> - <method name="has_main_screen" qualifiers="virtual"> - <return type="bool"> + <method name="add_control_to_bottom_panel"> + <return type="Button"> </return> + <argument index="0" name="control" type="Control"> + </argument> + <argument index="1" name="title" type="String"> + </argument> <description> - Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). + Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. </description> </method> - <method name="hide_bottom_panel"> + <method name="add_control_to_container"> <return type="void"> </return> + <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> <description> + Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. + Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). + When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_container] and free it with [method Node.queue_free]. </description> </method> - <method name="make_bottom_panel_item_visible"> + <method name="add_control_to_dock"> <return type="void"> </return> - <argument index="0" name="item" type="Control"> + <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot"> + </argument> + <argument index="1" name="control" type="Control"> </argument> <description> + Adds the control to a specific dock slot (see [enum DockSlot] for options). + If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. + When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_docks] and free it with [method Node.queue_free]. </description> </method> - <method name="make_visible" qualifiers="virtual"> + <method name="add_custom_type"> <return type="void"> </return> - <argument index="0" name="visible" type="bool"> + <argument index="0" name="type" type="String"> + </argument> + <argument index="1" name="base" type="String"> + </argument> + <argument index="2" name="script" type="Script"> + </argument> + <argument index="3" name="icon" type="Texture2D"> + </argument> + <description> + Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. + When given node or resource is selected, the base type will be instanced (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. + You can use the virtual method [method _handles] to check if your custom object is being edited by checking the script or using the [code]is[/code] keyword. + During run-time, this will be a simple object with a script so this function does not need to be called then. + </description> + </method> + <method name="add_debugger_plugin"> + <return type="void"> + </return> + <argument index="0" name="script" type="Script"> + </argument> + <description> + Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. + </description> + </method> + <method name="add_export_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorExportPlugin"> + </argument> + <description> + Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. + See [method add_inspector_plugin] for an example of how to register a plugin. + </description> + </method> + <method name="add_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="importer" type="EditorImportPlugin"> + </argument> + <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. + See [method add_inspector_plugin] for an example of how to register a plugin. + </description> + </method> + <method name="add_inspector_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorInspectorPlugin"> + </argument> + <description> + Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. + [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. + [codeblocks] + [gdscript] + const MyInspectorPlugin = preload("res://addons/your_addon/path/to/your/script.gd") + var inspector_plugin = MyInspectorPlugin.new() + + func _enter_tree(): + add_inspector_plugin(inspector_plugin) + + func _exit_tree(): + remove_inspector_plugin(inspector_plugin) + [/gdscript] + [/codeblocks] + </description> + </method> + <method name="add_scene_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="scene_importer" type="EditorSceneImporter"> + </argument> + <description> + Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. + </description> + </method> + <method name="add_spatial_gizmo_plugin"> + <return type="void"> + </return> + <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin"> + </argument> + <description> + Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. + See [method add_inspector_plugin] for an example of how to register a plugin. + </description> + </method> + <method name="add_tool_menu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="callable" type="Callable"> + </argument> + <description> + Adds a custom menu item to [b]Project > Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called. + </description> + </method> + <method name="add_tool_submenu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="submenu" type="Object"> + </argument> + <description> + Adds a custom submenu under [b]Project > Tools >[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. + </description> + </method> + <method name="add_translation_parser_plugin"> + <return type="void"> + </return> + <argument index="0" name="parser" type="EditorTranslationParserPlugin"> + </argument> + <description> + Registers a custom translation parser plugin for extracting translatable strings from custom files. + </description> + </method> + <method name="add_undo_redo_inspector_hook_callback"> + <return type="void"> + </return> + <argument index="0" name="callable" type="Callable"> + </argument> + <description> + Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. + The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. + </description> + </method> + <method name="get_editor_interface"> + <return type="EditorInterface"> + </return> + <description> + Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. + </description> + </method> + <method name="get_script_create_dialog"> + <return type="ScriptCreateDialog"> + </return> + <description> + Gets the Editor's dialogue used for making scripts. + [b]Note:[/b] Users can configure it before use. + </description> + </method> + <method name="get_undo_redo"> + <return type="UndoRedo"> + </return> + <description> + Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. + </description> + </method> + <method name="hide_bottom_panel"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="make_bottom_panel_item_visible"> + <return type="void"> + </return> + <argument index="0" name="item" type="Control"> </argument> <description> - This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. - Remember that you have to manage the visibility of all your editor controls manually. </description> </method> <method name="queue_save_layout"> @@ -667,50 +692,25 @@ Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback]. </description> </method> - <method name="save_external_data" qualifiers="virtual"> - <return type="void"> - </return> - <description> - This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. - </description> - </method> <method name="set_force_draw_over_forwarding_enabled"> <return type="void"> </return> <description> - Enables calling of [method forward_canvas_force_draw_over_viewport] for the 2D editor and [method forward_spatial_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. + Enables calling of [method _forward_canvas_force_draw_over_viewport] for the 2D editor and [method _forward_spatial_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. </description> </method> <method name="set_input_event_forwarding_always_enabled"> <return type="void"> </return> <description> - Use this method if you always want to receive inputs from 3D view screen inside [method forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. - </description> - </method> - <method name="set_state" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="state" type="Dictionary"> - </argument> - <description> - Restore the state saved by [method get_state]. - </description> - </method> - <method name="set_window_layout" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="layout" type="ConfigFile"> - </argument> - <description> - Restore the plugin GUI layout saved by [method get_window_layout]. + Use this method if you always want to receive inputs from 3D view screen inside [method _forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. </description> </method> <method name="update_overlays" qualifiers="const"> <return type="int"> </return> <description> - Updates the overlays of the 2D and 3D editor viewport. Causes methods [method forward_canvas_draw_over_viewport], [method forward_canvas_force_draw_over_viewport], [method forward_spatial_draw_over_viewport] and [method forward_spatial_force_draw_over_viewport] to be called. + Updates the overlays of the 2D and 3D editor viewport. Causes methods [method _forward_canvas_draw_over_viewport], [method _forward_canvas_force_draw_over_viewport], [method _forward_spatial_draw_over_viewport] and [method _forward_spatial_force_draw_over_viewport] to be called. </description> </method> </methods> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index f568263ff8..549d2c1628 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -9,6 +9,13 @@ <tutorials> </tutorials> <methods> + <method name="_update_property" qualifiers="virtual"> + <return type="void"> + </return> + <description> + When this virtual function is called, you must update your editor. + </description> + </method> <method name="add_focusable"> <return type="void"> </return> @@ -25,7 +32,7 @@ </argument> <argument index="1" name="value" type="Variant"> </argument> - <argument index="2" name="field" type="StringName" default="@"""> + <argument index="2" name="field" type="StringName" default="&"""> </argument> <argument index="3" name="changing" type="bool" default="false"> </argument> @@ -44,7 +51,7 @@ <return type="StringName"> </return> <description> - Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property. + Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin._parse_property]), then this will return the property. </description> </method> <method name="get_tooltip_text" qualifiers="const"> @@ -63,13 +70,6 @@ Adds controls with this function if you want them on the bottom (below the label). </description> </method> - <method name="update_property" qualifiers="virtual"> - <return type="void"> - </return> - <description> - When this virtual function is called, you must update your editor. - </description> - </method> </methods> <members> <member name="checkable" type="bool" setter="set_checkable" getter="is_checkable" default="false"> @@ -101,7 +101,7 @@ <argument index="1" name="value" type="Array"> </argument> <description> - Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property]. + Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property]. </description> </signal> <signal name="object_id_selected"> diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 1976eb802c..1d7e98c99d 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourceConversionPlugin" inherits="Reference" version="4.0"> +<class name="EditorResourceConversionPlugin" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/EditorResourcePicker.xml b/doc/classes/EditorResourcePicker.xml index 30c73daa77..0029955819 100644 --- a/doc/classes/EditorResourcePicker.xml +++ b/doc/classes/EditorResourcePicker.xml @@ -10,28 +10,23 @@ <tutorials> </tutorials> <methods> - <method name="can_drop_data_fw" qualifiers="const"> - <return type="bool"> + <method name="_handle_menu_selected" qualifiers="virtual"> + <return type="void"> </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> + <argument index="0" name="id" type="int"> </argument> <description> + This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options]. </description> </method> - <method name="drop_data_fw"> + <method name="_set_create_options" qualifiers="virtual"> <return type="void"> </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> + <argument index="0" name="menu_node" type="Object"> </argument> <description> + This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node. + [b]Note:[/b] Implement [method _handle_menu_selected] to handle these custom items. </description> </method> <method name="get_allowed_types" qualifiers="const"> @@ -41,35 +36,6 @@ Returns a list of all allowed types and subtypes corresponding to the [member base_type]. If the [member base_type] is empty, an empty list is returned. </description> </method> - <method name="get_drag_data_fw"> - <return type="Variant"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="from" type="Control"> - </argument> - <description> - </description> - </method> - <method name="handle_menu_selected" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - This virtual method can be implemented to handle context menu items not handled by default. See [method set_create_options]. - </description> - </method> - <method name="set_create_options" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="menu_node" type="Object"> - </argument> - <description> - This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node. - [b]Note:[/b] Implement [method handle_menu_selected] to handle these custom items. - </description> - </method> <method name="set_toggle_pressed"> <return type="void"> </return> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index e935bf19fc..3594474e36 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreviewGenerator" inherits="Reference" version="4.0"> +<class name="EditorResourcePreviewGenerator" inherits="RefCounted" version="4.0"> <brief_description> Custom generator of previews. </brief_description> @@ -9,15 +9,15 @@ <tutorials> </tutorials> <methods> - <method name="can_generate_small_preview" qualifiers="virtual"> + <method name="_can_generate_small_preview" qualifiers="virtual"> <return type="bool"> </return> <description> - If this function returns [code]true[/code], the generator will call [method generate] or [method generate_from_path] for small previews as well. + If this function returns [code]true[/code], the generator will call [method _generate] or [method _generate_from_path] for small previews as well. By default, it returns [code]false[/code]. </description> </method> - <method name="generate" qualifiers="virtual"> + <method name="_generate" qualifiers="virtual"> <return type="Texture2D"> </return> <argument index="0" name="from" type="Resource"> @@ -30,7 +30,7 @@ Care must be taken because this function is always called from a thread (not the main thread). </description> </method> - <method name="generate_from_path" qualifiers="virtual"> + <method name="_generate_from_path" qualifiers="virtual"> <return type="Texture2D"> </return> <argument index="0" name="path" type="String"> @@ -38,20 +38,20 @@ <argument index="1" name="size" type="Vector2"> </argument> <description> - Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method generate]. + Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate]. Returning an empty texture is an OK way to fail and let another generator take care. Care must be taken because this function is always called from a thread (not the main thread). </description> </method> - <method name="generate_small_preview_automatically" qualifiers="virtual"> + <method name="_generate_small_preview_automatically" qualifiers="virtual"> <return type="bool"> </return> <description> - If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path]. + If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method _generate] or [method _generate_from_path]. By default, it returns [code]false[/code]. </description> </method> - <method name="handles" qualifiers="virtual"> + <method name="_handles" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="type" type="String"> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml index aa55a1653d..8df3091057 100644 --- a/doc/classes/EditorSceneImporter.xml +++ b/doc/classes/EditorSceneImporter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporter" inherits="Reference" version="4.0"> +<class name="EditorSceneImporter" inherits="RefCounted" version="4.0"> <brief_description> Imports scenes from third-parties' 3D files. </brief_description> diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index d1cdc4e43e..d2b5e84ff7 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -1,18 +1,18 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScenePostImport" inherits="Reference" version="4.0"> +<class name="EditorScenePostImport" inherits="RefCounted" version="4.0"> <brief_description> Post-processes scenes after import. </brief_description> <description> Imported scenes can be automatically modified right after import by setting their [b]Custom Script[/b] Import property to a [code]tool[/code] script that inherits from this class. - The [method post_import] callback receives the imported scene's root node and returns the modified version of the scene. Usage example: + The [method _post_import] callback receives the imported scene's root node and returns the modified version of the scene. Usage example: [codeblocks] [gdscript] tool # Needed so it runs in editor. extends EditorScenePostImport # This sample changes all node names. # Called right after the scene is imported and gets the root node. - func post_import(scene): + func _post_import(scene): # Change all node names to "modified_[oldnodename]" iterate(scene) return scene # Remember to return the imported scene @@ -55,14 +55,7 @@ <link title="Importing 3D scenes: Custom script">https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_scenes.html#custom-script</link> </tutorials> <methods> - <method name="get_source_file" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]). - </description> - </method> - <method name="post_import" qualifiers="virtual"> + <method name="_post_import" qualifiers="virtual"> <return type="Object"> </return> <argument index="0" name="scene" type="Object"> @@ -71,6 +64,13 @@ Called after the scene was imported. This method must return the modified version of the scene. </description> </method> + <method name="get_source_file" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]). + </description> + </method> </methods> <constants> </constants> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 60ccf451b8..a91ea0eb14 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorScript" inherits="Reference" version="4.0"> +<class name="EditorScript" inherits="RefCounted" version="4.0"> <brief_description> Base script that can be used to add extension functions to the editor. </brief_description> diff --git a/doc/classes/EditorSyntaxHighlighter.xml b/doc/classes/EditorSyntaxHighlighter.xml index b80e81928f..d81b25345f 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 [method ScriptEditorBase.add_syntax_highlighter]. 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 c97459d9dc..a9f4e90e72 100644 --- a/doc/classes/EditorTranslationParserPlugin.xml +++ b/doc/classes/EditorTranslationParserPlugin.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorTranslationParserPlugin" inherits="Reference" version="4.0"> +<class name="EditorTranslationParserPlugin" inherits="RefCounted" version="4.0"> <brief_description> 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. + 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. 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. @@ -14,7 +14,7 @@ tool extends EditorTranslationParserPlugin - func parse_file(path, msgids, msgids_context_plural): + func _parse_file(path, msgids, msgids_context_plural): var file = File.new() file.open(path, File.READ) var text = file.get_as_text() @@ -23,7 +23,7 @@ msgids.append(s) #print("Extracted string: " + s) - func get_recognized_extensions(): + func _get_recognized_extensions(): return ["csv"] [/gdscript] [csharp] @@ -76,12 +76,12 @@ For example: [codeblocks] [gdscript] - func parse_file(path, msgids, msgids_context_plural): + func _parse_file(path, msgids, msgids_context_plural): var res = ResourceLoader.load(path, "Script") var text = res.source_code # Parsing logic. - func get_recognized_extensions(): + func _get_recognized_extensions(): return ["gd"] [/gdscript] [csharp] @@ -102,14 +102,14 @@ <tutorials> </tutorials> <methods> - <method name="get_recognized_extensions" qualifiers="virtual"> + <method name="_get_recognized_extensions" qualifiers="virtual"> <return type="Array"> </return> <description> Gets the list of file extensions to associate with this parser, e.g. [code]["csv"][/code]. </description> </method> - <method name="parse_file" qualifiers="virtual"> + <method name="_parse_file" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="path" type="String"> diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml index 1e4fde453b..e3e36590a3 100644 --- a/doc/classes/EncodedObjectAsID.xml +++ b/doc/classes/EncodedObjectAsID.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EncodedObjectAsID" inherits="Reference" version="4.0"> +<class name="EncodedObjectAsID" inherits="RefCounted" version="4.0"> <brief_description> Holds a reference to an [Object]'s instance ID. </brief_description> diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml index d777c6fd9d..e41de4c4ed 100644 --- a/doc/classes/Expression.xml +++ b/doc/classes/Expression.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Expression" inherits="Reference" version="4.0"> +<class name="Expression" inherits="RefCounted" version="4.0"> <brief_description> A class that stores an expression you can execute. </brief_description> diff --git a/doc/classes/File.xml b/doc/classes/File.xml index ea3b82dc54..7feaaa2040 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="File" inherits="Reference" version="4.0"> +<class name="File" inherits="RefCounted" version="4.0"> <brief_description> Type to handle file reading and writing operations. </brief_description> @@ -188,7 +188,7 @@ <argument index="0" name="file" type="String"> </argument> <description> - Returns the last time the [code]file[/code] was modified in unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time]. + Returns the last time the [code]file[/code] was modified in Unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This Unix timestamp can be converted to another format using the [Time] singleton. </description> </method> <method name="get_pascal_string"> diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index c553f90e37..15f92e90e3 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -7,40 +7,6 @@ <tutorials> </tutorials> <methods> - <method name="can_drop_data_fw" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> - </argument> - <description> - </description> - </method> - <method name="drop_data_fw"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> - </argument> - <description> - </description> - </method> - <method name="get_drag_data_fw"> - <return type="Variant"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="from" type="Control"> - </argument> - <description> - </description> - </method> <method name="navigate_to_path"> <return type="void"> </return> diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index b2c3bfc3ed..667ca2dacf 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -52,25 +52,21 @@ </member> <member name="lod_bias" type="float" setter="set_lod_bias" getter="get_lod_bias" default="1.0"> </member> - <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance" default="0.0"> - The GeometryInstance3D's max LOD distance. - [b]Note:[/b] This property currently has no effect. + <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> + 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="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis" default="0.0"> - The GeometryInstance3D's max LOD margin. - [b]Note:[/b] This property currently has no effect. + <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> - <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance" default="0.0"> - The GeometryInstance3D's min LOD distance. - [b]Note:[/b] This property currently has no effect. + <member name="visibility_range_begin_margin" type="float" setter="set_visibility_range_begin_margin" getter="get_visibility_range_begin_margin" default="0.0"> + 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="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis" default="0.0"> - The GeometryInstance3D's min LOD margin. - [b]Note:[/b] This property currently has no effect. + <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.. </member> - <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> - 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 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> </members> <constants> diff --git a/doc/classes/HMACContext.xml b/doc/classes/HMACContext.xml index 00d528ef8f..9fa96e5ddf 100644 --- a/doc/classes/HMACContext.xml +++ b/doc/classes/HMACContext.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HMACContext" inherits="Reference" version="4.0"> +<class name="HMACContext" inherits="RefCounted" version="4.0"> <brief_description> Used to create an HMAC for a message using a key. </brief_description> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index ddfcdf7724..a549994a69 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPClient" inherits="Reference" version="4.0"> +<class name="HTTPClient" inherits="RefCounted" version="4.0"> <brief_description> Low-level hyper-text transfer protocol client. </brief_description> diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index e020293d76..1c7b7ca937 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HashingContext" inherits="Reference" version="4.0"> +<class name="HashingContext" inherits="RefCounted" version="4.0"> <brief_description> Context to compute cryptographic hashes over multiple iterations. </brief_description> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index ed290fc7e2..42326f344f 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -14,7 +14,7 @@ <methods> </methods> <members> - <member name="action" type="StringName" setter="set_action" getter="get_action" default="@"""> + <member name="action" type="StringName" setter="set_action" getter="get_action" default="&"""> The action's name. Actions are accessed via this [String]. </member> <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index a9fb50c262..7baff7aa39 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -27,9 +27,12 @@ </argument> <argument index="2" name="sort_keys" type="bool" default="false"> </argument> + <argument index="3" name="full_precision" type="bool" default="false"> + </argument> <description> Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. + [b]Note:[/b] If [code]full_precision[/code] is true, when printing floats, the unreliable digits are printed in addition to the reliable digits to guarantee exact decoding. Use [code]indent[/code] parameter to pretty print the output. [b]Example output:[/b] [codeblock] diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index bc94f74b07..7311343b68 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSONParseResult" inherits="Reference" version="4.0"> +<class name="JSONParseResult" inherits="RefCounted" version="4.0"> <brief_description> Data class wrapper for decoded JSON. </brief_description> diff --git a/doc/classes/JSONParser.xml b/doc/classes/JSONParser.xml index 31ba295418..991629f255 100644 --- a/doc/classes/JSONParser.xml +++ b/doc/classes/JSONParser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JSONParser" inherits="Reference" version="4.0"> +<class name="JSONParser" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/JavaClass.xml b/doc/classes/JavaClass.xml index 69b7a9b718..0b6a44fe14 100644 --- a/doc/classes/JavaClass.xml +++ b/doc/classes/JavaClass.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JavaClass" inherits="Reference" version="4.0"> +<class name="JavaClass" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/JavaScriptObject.xml b/doc/classes/JavaScriptObject.xml index a9e9c77e89..087fe163b4 100644 --- a/doc/classes/JavaScriptObject.xml +++ b/doc/classes/JavaScriptObject.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="JavaScriptObject" inherits="Reference" version="4.0"> +<class name="JavaScriptObject" inherits="RefCounted" version="4.0"> <brief_description> A wrapper class for native JavaScript objects. </brief_description> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 8748f89618..5480d7d55f 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision2D" inherits="Reference" version="4.0"> +<class name="KinematicCollision2D" inherits="RefCounted" version="4.0"> <brief_description> Collision data for [method PhysicsBody2D.move_and_collide] collisions. </brief_description> diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 8eac15ebf4..329efab474 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="KinematicCollision3D" inherits="Reference" version="4.0"> +<class name="KinematicCollision3D" inherits="RefCounted" version="4.0"> <brief_description> Collision data for [method PhysicsBody3D.move_and_collide] collisions. </brief_description> diff --git a/doc/classes/Lightmapper.xml b/doc/classes/Lightmapper.xml index e80194858a..79fae42d68 100644 --- a/doc/classes/Lightmapper.xml +++ b/doc/classes/Lightmapper.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Lightmapper" inherits="Reference" version="4.0"> +<class name="Lightmapper" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 3c679047a0..da02511dc0 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MeshDataTool" inherits="Reference" version="4.0"> +<class name="MeshDataTool" inherits="RefCounted" version="4.0"> <brief_description> Helper tool to access and edit [Mesh] data. </brief_description> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index b2be92dbbd..5de5703d95 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiplayerAPI" inherits="Reference" version="4.0"> +<class name="MultiplayerAPI" inherits="RefCounted" version="4.0"> <brief_description> High-level multiplayer API. </brief_description> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index f5f6308401..dfda614f8e 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Mutex" inherits="Reference" version="4.0"> +<class name="Mutex" inherits="RefCounted" version="4.0"> <brief_description> A synchronization mutex (mutual exclusion). </brief_description> diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml index a6237708c6..1c161803db 100644 --- a/doc/classes/Node3D.xml +++ b/doc/classes/Node3D.xml @@ -20,7 +20,7 @@ Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. </description> </method> - <method name="get_parent_spatial" qualifiers="const"> + <method name="get_parent_node_3d" qualifiers="const"> <return type="Node3D"> </return> <description> @@ -310,6 +310,9 @@ <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 )"> Local space [Transform3D] of this node, with respect to the parent node. </member> + <member name="visibility_parent" type="NodePath" setter="set_visibility_parent" getter="get_visibility_parent" default="NodePath("")"> + Defines the visibility range parent for this node and its subtree. The visibility parent must be a GeometryInstance3D. Any visual instance will only be visible if the visibility parent (and all of its visibility ancestors) is hidden by being closer to the camera than its own [member GeometryInstance3D.visibility_range_begin]. Nodes hidden via the [member Node3D.visible] property are essentially removed from the visibility dependency tree, so dependant instances will not take the hidden node or its ancestors into account. + </member> <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> If [code]true[/code], this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]). </member> diff --git a/doc/classes/Node3DGizmo.xml b/doc/classes/Node3DGizmo.xml index 55080614fc..c561047332 100644 --- a/doc/classes/Node3DGizmo.xml +++ b/doc/classes/Node3DGizmo.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Node3DGizmo" inherits="Reference" version="4.0"> +<class name="Node3DGizmo" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index b8b437f78f..bfcd5b1beb 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -176,34 +176,6 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> - <method name="get_date" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="utc" type="bool" default="false"> - </argument> - <description> - Returns current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time). - </description> - </method> - <method name="get_datetime" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="utc" type="bool" default="false"> - </argument> - <description> - Returns current datetime 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], [code]second[/code]. - </description> - </method> - <method name="get_datetime_from_unix_time" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="unix_time_val" type="int"> - </argument> - <description> - Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds). - The returned Dictionary's values will be the same as [method get_datetime], with the exception of Daylight Savings Time as it cannot be determined from the epoch. - </description> - </method> <method name="get_environment" qualifiers="const"> <return type="String"> </return> @@ -221,6 +193,13 @@ Returns the path to the current engine executable. </description> </method> + <method name="get_external_data_dir" qualifiers="const"> + <return type="String"> + </return> + <description> + On Android, returns the absolute directory path where user data can be written to external storage if available. On all other platforms, this will return the same location as [method get_user_data_dir]. + </description> + </method> <method name="get_granted_permissions" qualifiers="const"> <return type="PackedStringArray"> </return> @@ -313,36 +292,6 @@ [b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts. </description> </method> - <method name="get_ticks_msec" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the amount of time passed in milliseconds since the engine started. - </description> - </method> - <method name="get_ticks_usec" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the amount of time passed in microseconds since the engine started. - </description> - </method> - <method name="get_time" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="utc" type="bool" default="false"> - </argument> - <description> - Returns current time as a dictionary of keys: hour, minute, second. - </description> - </method> - <method name="get_time_zone_info" qualifiers="const"> - <return type="Dictionary"> - </return> - <description> - Returns the current time zone as a dictionary with the keys: bias and name. - </description> - </method> <method name="get_unique_id" qualifiers="const"> <return type="String"> </return> @@ -352,26 +301,6 @@ [b]Note:[/b] Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet. </description> </method> - <method name="get_unix_time" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the current UNIX epoch timestamp in seconds. - [b]Important:[/b] This is the system clock that the user can manually set. [b]Never use[/b] this method for precise time calculation since its results are also subject to automatic adjustments by 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> - </method> - <method name="get_unix_time_from_datetime" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="datetime" type="Dictionary"> - </argument> - <description> - Gets an epoch time value from a dictionary of time values. - [code]datetime[/code] must be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], [code]second[/code]. - 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 UTC). - You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight Savings Time ([code]dst[/code]), if present, is ignored. - </description> - </method> <method name="get_user_data_dir" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 7da9c1ac38..f5dcd6bcdc 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -7,7 +7,7 @@ Every class which is not a built-in type inherits from this class. You can construct Objects from scripting languages, using [code]Object.new()[/code] in GDScript, [code]new Object[/code] in C#, or the "Construct Object" node in VisualScript. Objects do not manage memory. If a class inherits from Object, you will have to delete instances of it manually. To do so, call the [method free] method from your script or delete the instance from C++. - Some classes that extend Object add memory management. This is the case of [Reference], which counts references and deletes itself automatically when no longer referenced. [Node], another fundamental type, deletes all its children when freed from memory. + Some classes that extend Object add memory management. This is the case of [RefCounted], which counts references and deletes itself automatically when no longer referenced. [Node], another fundamental type, deletes all its children when freed from memory. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them. Property membership can be tested directly in GDScript using [code]in[/code]: [codeblocks] @@ -26,7 +26,7 @@ [/codeblocks] The [code]in[/code] operator will evaluate to [code]true[/code] as long as the key exists, even if the value is [code]null[/code]. Objects also receive notifications. Notifications are a simple way to notify the object about different events, so they can all be handled together. See [method _notification]. - [b]Note:[/b] Unlike references to a [Reference], references to an Object stored in a variable can become invalid without warning. Therefore, it's recommended to use [Reference] for data classes instead of [Object]. + [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> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index e3c78e08f1..40e8683c93 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PCKPacker" inherits="Reference" version="4.0"> +<class name="PCKPacker" inherits="RefCounted" version="4.0"> <brief_description> Creates packages that can be loaded into a running project. </brief_description> diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index f0f59675de..bfd5a6f1c1 100644 --- a/doc/classes/PackedDataContainerRef.xml +++ b/doc/classes/PackedDataContainerRef.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PackedDataContainerRef" inherits="Reference" version="4.0"> +<class name="PackedDataContainerRef" inherits="RefCounted" version="4.0"> <brief_description> - Reference version of [PackedDataContainer]. + Reference-counted version of [PackedDataContainer]. </brief_description> <description> </description> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index e3e2f63e14..0a758c2cd6 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeer" inherits="Reference" version="4.0"> +<class name="PacketPeer" inherits="RefCounted" version="4.0"> <brief_description> Abstraction and base class for packet-based protocols. </brief_description> diff --git a/doc/classes/PhysicsShapeQueryParameters2D.xml b/doc/classes/PhysicsShapeQueryParameters2D.xml index 4d7fc61517..92bd9b136a 100644 --- a/doc/classes/PhysicsShapeQueryParameters2D.xml +++ b/doc/classes/PhysicsShapeQueryParameters2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryParameters2D" inherits="Reference" version="4.0"> +<class name="PhysicsShapeQueryParameters2D" inherits="RefCounted" version="4.0"> <brief_description> Parameters to be sent to a 2D shape physics query. </brief_description> diff --git a/doc/classes/PhysicsShapeQueryParameters3D.xml b/doc/classes/PhysicsShapeQueryParameters3D.xml index 79bc29057f..087c52a650 100644 --- a/doc/classes/PhysicsShapeQueryParameters3D.xml +++ b/doc/classes/PhysicsShapeQueryParameters3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryParameters3D" inherits="Reference" version="4.0"> +<class name="PhysicsShapeQueryParameters3D" inherits="RefCounted" version="4.0"> <brief_description> Parameters to be sent to a 3D shape physics query. </brief_description> diff --git a/doc/classes/PhysicsShapeQueryResult2D.xml b/doc/classes/PhysicsShapeQueryResult2D.xml index 227683cc33..07b7bc90e2 100644 --- a/doc/classes/PhysicsShapeQueryResult2D.xml +++ b/doc/classes/PhysicsShapeQueryResult2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryResult2D" inherits="Reference" version="4.0"> +<class name="PhysicsShapeQueryResult2D" inherits="RefCounted" version="4.0"> <brief_description> Result of a 2D shape query in [PhysicsServer2D]. </brief_description> diff --git a/doc/classes/PhysicsShapeQueryResult3D.xml b/doc/classes/PhysicsShapeQueryResult3D.xml index 4555c4e242..d0ca227a68 100644 --- a/doc/classes/PhysicsShapeQueryResult3D.xml +++ b/doc/classes/PhysicsShapeQueryResult3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsShapeQueryResult3D" inherits="Reference" version="4.0"> +<class name="PhysicsShapeQueryResult3D" inherits="RefCounted" version="4.0"> <brief_description> Result of a 3D shape query in [PhysicsServer3D]. </brief_description> diff --git a/doc/classes/PhysicsTestMotionResult2D.xml b/doc/classes/PhysicsTestMotionResult2D.xml index 301cff2885..2744aa17a1 100644 --- a/doc/classes/PhysicsTestMotionResult2D.xml +++ b/doc/classes/PhysicsTestMotionResult2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PhysicsTestMotionResult2D" inherits="Reference" version="4.0"> +<class name="PhysicsTestMotionResult2D" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index b74a1f848b..360ccc597e 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1139,8 +1139,6 @@ <member name="layer_names/3d_render/layer_9" type="String" setter="" getter="" default=""""> Optional name for the 3D render layer 9. If left empty, the layer will display as "Layer 9". </member> - <member name="memory/limits/command_queue/multithreading_queue_size_kb" type="int" setter="" getter="" default="256"> - </member> <member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="4096"> Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here. </member> @@ -1576,20 +1574,31 @@ <member name="rendering/textures/default_filters/use_nearest_mipmap_filter" type="bool" setter="" getter="" default="false"> If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used. </member> + <member name="rendering/textures/lossless_compression/force_png" type="bool" setter="" getter="" default="false"> + If [code]true[/code], the texture importer will import lossless textures using the PNG format. Otherwise, it will default to using WebP. + </member> + <member name="rendering/textures/lossless_compression/webp_compression_level" type="int" setter="" getter="" default="2"> + The default compression level for lossless WebP. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. Supported values are 0 to 9. Note that compression levels above 6 are very slow and offer very little savings. + </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. </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. </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. </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. </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. </member> <member name="rendering/vulkan/descriptor_pools/max_descriptors_per_pool" type="int" setter="" getter="" default="64"> </member> @@ -1603,6 +1612,9 @@ </member> <member name="rendering/vulkan/staging_buffer/texture_upload_region_size_px" type="int" setter="" getter="" default="64"> </member> + <member name="rendering/xr/enabled" type="bool" setter="" getter="" default="false"> + If [code]true[/code], XR support is enabled in Godot, this ensures required shaders are compiled. + </member> <member name="world/2d/cell_size" type="int" setter="" getter="" default="100"> Cell size used for the 2D hash grid that [VisibilityNotifier2D] uses (in pixels). </member> diff --git a/doc/classes/RDAttachmentFormat.xml b/doc/classes/RDAttachmentFormat.xml index 4ee7b9b28e..b73377bf77 100644 --- a/doc/classes/RDAttachmentFormat.xml +++ b/doc/classes/RDAttachmentFormat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDAttachmentFormat" inherits="Reference" version="4.0"> +<class name="RDAttachmentFormat" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDPipelineColorBlendState.xml b/doc/classes/RDPipelineColorBlendState.xml index adc6f1f6a3..1424a0d653 100644 --- a/doc/classes/RDPipelineColorBlendState.xml +++ b/doc/classes/RDPipelineColorBlendState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDPipelineColorBlendState" inherits="Reference" version="4.0"> +<class name="RDPipelineColorBlendState" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDPipelineColorBlendStateAttachment.xml b/doc/classes/RDPipelineColorBlendStateAttachment.xml index 7f118b5f0b..a6a1900cb5 100644 --- a/doc/classes/RDPipelineColorBlendStateAttachment.xml +++ b/doc/classes/RDPipelineColorBlendStateAttachment.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDPipelineColorBlendStateAttachment" inherits="Reference" version="4.0"> +<class name="RDPipelineColorBlendStateAttachment" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDPipelineDepthStencilState.xml b/doc/classes/RDPipelineDepthStencilState.xml index 562ff52819..76e0506bca 100644 --- a/doc/classes/RDPipelineDepthStencilState.xml +++ b/doc/classes/RDPipelineDepthStencilState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDPipelineDepthStencilState" inherits="Reference" version="4.0"> +<class name="RDPipelineDepthStencilState" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDPipelineMultisampleState.xml b/doc/classes/RDPipelineMultisampleState.xml index 4658c7d9ba..8c90f02301 100644 --- a/doc/classes/RDPipelineMultisampleState.xml +++ b/doc/classes/RDPipelineMultisampleState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDPipelineMultisampleState" inherits="Reference" version="4.0"> +<class name="RDPipelineMultisampleState" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDPipelineRasterizationState.xml b/doc/classes/RDPipelineRasterizationState.xml index 5064dd6deb..3f8c50cf42 100644 --- a/doc/classes/RDPipelineRasterizationState.xml +++ b/doc/classes/RDPipelineRasterizationState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDPipelineRasterizationState" inherits="Reference" version="4.0"> +<class name="RDPipelineRasterizationState" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDSamplerState.xml b/doc/classes/RDSamplerState.xml index ab31960b7c..9a9d55948c 100644 --- a/doc/classes/RDSamplerState.xml +++ b/doc/classes/RDSamplerState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDSamplerState" inherits="Reference" version="4.0"> +<class name="RDSamplerState" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDShaderFile.xml b/doc/classes/RDShaderFile.xml index 14e70d53ea..346a97a1c0 100644 --- a/doc/classes/RDShaderFile.xml +++ b/doc/classes/RDShaderFile.xml @@ -10,7 +10,7 @@ <method name="get_bytecode" qualifiers="const"> <return type="RDShaderBytecode"> </return> - <argument index="0" name="version" type="StringName" default="@"""> + <argument index="0" name="version" type="StringName" default="&"""> </argument> <description> </description> @@ -26,7 +26,7 @@ </return> <argument index="0" name="bytecode" type="RDShaderBytecode"> </argument> - <argument index="1" name="version" type="StringName" default="@"""> + <argument index="1" name="version" type="StringName" default="&"""> </argument> <description> </description> diff --git a/doc/classes/RDShaderSource.xml b/doc/classes/RDShaderSource.xml index c1cfd34bb7..68fc43d8ef 100644 --- a/doc/classes/RDShaderSource.xml +++ b/doc/classes/RDShaderSource.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDShaderSource" inherits="Reference" version="4.0"> +<class name="RDShaderSource" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDTextureFormat.xml b/doc/classes/RDTextureFormat.xml index e41ddff368..ccfa6d1b95 100644 --- a/doc/classes/RDTextureFormat.xml +++ b/doc/classes/RDTextureFormat.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDTextureFormat" inherits="Reference" version="4.0"> +<class name="RDTextureFormat" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDTextureView.xml b/doc/classes/RDTextureView.xml index 73b2a7ae4a..db140ae775 100644 --- a/doc/classes/RDTextureView.xml +++ b/doc/classes/RDTextureView.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDTextureView" inherits="Reference" version="4.0"> +<class name="RDTextureView" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDUniform.xml b/doc/classes/RDUniform.xml index bc8a21e985..666935d663 100644 --- a/doc/classes/RDUniform.xml +++ b/doc/classes/RDUniform.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDUniform" inherits="Reference" version="4.0"> +<class name="RDUniform" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RDVertexAttribute.xml b/doc/classes/RDVertexAttribute.xml index 56fe40b51d..3499918cc8 100644 --- a/doc/classes/RDVertexAttribute.xml +++ b/doc/classes/RDVertexAttribute.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RDVertexAttribute" inherits="Reference" version="4.0"> +<class name="RDVertexAttribute" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 6312cd18aa..6fcb79b5fe 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RandomNumberGenerator" inherits="Reference" version="4.0"> +<class name="RandomNumberGenerator" inherits="RefCounted" version="4.0"> <brief_description> A class for generating pseudo-random numbers. </brief_description> diff --git a/doc/classes/Reference.xml b/doc/classes/RefCounted.xml index 724d2db924..cf96514203 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/RefCounted.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Reference" inherits="Object" version="4.0"> +<class name="RefCounted" inherits="Object" version="4.0"> <brief_description> Base class for reference-counted objects. </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]. - In the vast majority of use cases, instantiating and using [Reference]-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. + 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. </description> <tutorials> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index ba19176788..9b9644093f 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1175,17 +1175,6 @@ Once finished with your RID, you will want to free the RID using the RenderingServer's [method free_rid] static method. </description> </method> - <method name="instance_geometry_set_as_instance_lod"> - <return type="void"> - </return> - <argument index="0" name="instance" type="RID"> - </argument> - <argument index="1" name="as_lod_of_instance" type="RID"> - </argument> - <description> - Not implemented in Godot 3.x. - </description> - </method> <method name="instance_geometry_set_cast_shadows_setting"> <return type="void"> </return> @@ -1197,45 +1186,45 @@ Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow]. </description> </method> - <method name="instance_geometry_set_draw_range"> + <method name="instance_geometry_set_flag"> <return type="void"> </return> <argument index="0" name="instance" type="RID"> </argument> - <argument index="1" name="min" type="float"> - </argument> - <argument index="2" name="max" type="float"> - </argument> - <argument index="3" name="min_margin" type="float"> + <argument index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags"> </argument> - <argument index="4" name="max_margin" type="float"> + <argument index="2" name="enabled" type="bool"> </argument> <description> - Not implemented in Godot 3.x. + Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. </description> </method> - <method name="instance_geometry_set_flag"> + <method name="instance_geometry_set_material_override"> <return type="void"> </return> <argument index="0" name="instance" type="RID"> </argument> - <argument index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags"> - </argument> - <argument index="2" name="enabled" type="bool"> + <argument index="1" name="material" type="RID"> </argument> <description> - Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. + Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override]. </description> </method> - <method name="instance_geometry_set_material_override"> + <method name="instance_geometry_set_visibility_range"> <return type="void"> </return> <argument index="0" name="instance" type="RID"> </argument> - <argument index="1" name="material" type="RID"> + <argument index="1" name="min" type="float"> + </argument> + <argument index="2" name="max" type="float"> + </argument> + <argument index="3" name="min_margin" type="float"> + </argument> + <argument index="4" name="max_margin" type="float"> </argument> <description> - Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance3D.material_override]. + Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties. </description> </method> <method name="instance_set_base"> @@ -1341,6 +1330,17 @@ Sets the world space transform of the instance. Equivalent to [member Node3D.transform]. </description> </method> + <method name="instance_set_visibility_parent"> + <return type="void"> + </return> + <argument index="0" name="instance" type="RID"> + </argument> + <argument index="1" name="parent" type="RID"> + </argument> + <description> + Sets the visibility parent for the given instance. Equivalent to [member Node3D.visibility_parent]. + </description> + </method> <method name="instance_set_visible"> <return type="void"> </return> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 75736798fd..6edb3b1a11 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Resource" inherits="Reference" version="4.0"> +<class name="Resource" inherits="RefCounted" version="4.0"> <brief_description> Base class for all resources. </brief_description> <description> - Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Since they inherit from [Reference], resources are reference-counted and freed when no longer in use. They are also cached once loaded from disk, so that any further attempts to load a resource from a given path will return the same reference (all this in contrast to a [Node], which is not reference-counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Since they inherit from [RefCounted], resources are reference-counted and freed when no longer in use. They are also cached once loaded from disk, so that any further attempts to load a resource from a given path will return the same reference (all this in contrast to a [Node], which is not reference-counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. [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> diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index 9943f644cf..6abe5c813b 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceFormatLoader" inherits="Reference" version="4.0"> +<class name="ResourceFormatLoader" inherits="RefCounted" version="4.0"> <brief_description> Loads a specific resource type from a file. </brief_description> @@ -11,7 +11,7 @@ <tutorials> </tutorials> <methods> - <method name="get_dependencies" qualifiers="virtual"> + <method name="_get_dependencies" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="path" type="String"> @@ -23,14 +23,14 @@ [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. </description> </method> - <method name="get_recognized_extensions" qualifiers="virtual"> + <method name="_get_recognized_extensions" qualifiers="virtual"> <return type="PackedStringArray"> </return> <description> Gets the list of extensions for files this loader is able to read. </description> </method> - <method name="get_resource_type" qualifiers="virtual"> + <method name="_get_resource_type" qualifiers="virtual"> <return type="String"> </return> <argument index="0" name="path" type="String"> @@ -40,7 +40,7 @@ [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. </description> </method> - <method name="handles_type" qualifiers="virtual"> + <method name="_handles_type" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="typename" type="StringName"> @@ -50,7 +50,7 @@ [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. </description> </method> - <method name="load" qualifiers="virtual"> + <method name="_load" qualifiers="virtual"> <return type="Variant"> </return> <argument index="0" name="path" type="String"> @@ -66,7 +66,7 @@ The [code]cache_mode[/code] property defines whether and how the cache should be used or updated when loading the resource. See [enum CacheMode] for details. </description> </method> - <method name="rename_dependencies" qualifiers="virtual"> + <method name="_rename_dependencies" qualifiers="virtual"> <return type="int"> </return> <argument index="0" name="path" type="String"> diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index 69f8b43898..df71e05d02 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceFormatSaver" inherits="Reference" version="4.0"> +<class name="ResourceFormatSaver" inherits="RefCounted" version="4.0"> <brief_description> Saves a specific resource type to a file. </brief_description> @@ -10,16 +10,16 @@ <tutorials> </tutorials> <methods> - <method name="get_recognized_extensions" qualifiers="virtual"> + <method name="_get_recognized_extensions" qualifiers="virtual"> <return type="PackedStringArray"> </return> <argument index="0" name="resource" type="Resource"> </argument> <description> - Returns the list of extensions available for saving the resource object, provided it is recognized (see [method recognize]). + Returns the list of extensions available for saving the resource object, provided it is recognized (see [method _recognize]). </description> </method> - <method name="recognize" qualifiers="virtual"> + <method name="_recognize" qualifiers="virtual"> <return type="bool"> </return> <argument index="0" name="resource" type="Resource"> @@ -28,7 +28,7 @@ Returns whether the given resource object can be saved by this saver. </description> </method> - <method name="save" qualifiers="virtual"> + <method name="_save" qualifiers="virtual"> <return type="int"> </return> <argument index="0" name="path" type="String"> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml index 0475d2c94d..59900b1b73 100644 --- a/doc/classes/ResourceImporter.xml +++ b/doc/classes/ResourceImporter.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="ResourceImporter" inherits="Reference" version="4.0"> +<class name="ResourceImporter" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index abc429d5fe..f9e0ef76b9 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneState" inherits="Reference" version="4.0"> +<class name="SceneState" inherits="RefCounted" version="4.0"> <brief_description> A script interface to a scene file's data. </brief_description> diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml index b223bf6821..4eef754345 100644 --- a/doc/classes/SceneTreeTimer.xml +++ b/doc/classes/SceneTreeTimer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SceneTreeTimer" inherits="Reference" version="4.0"> +<class name="SceneTreeTimer" inherits="RefCounted" version="4.0"> <brief_description> One-shot timer. </brief_description> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 28620bd29b..31dbf7453f 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -9,30 +9,6 @@ <tutorials> </tutorials> <methods> - <method name="can_drop_data_fw" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> - </argument> - <description> - </description> - </method> - <method name="drop_data_fw"> - <return type="void"> - </return> - <argument index="0" name="point" type="Vector2"> - </argument> - <argument index="1" name="data" type="Variant"> - </argument> - <argument index="2" name="from" type="Control"> - </argument> - <description> - </description> - </method> <method name="get_current_editor" qualifiers="const"> <return type="ScriptEditorBase"> </return> @@ -47,16 +23,6 @@ Returns a [Script] that is currently active in editor. </description> </method> - <method name="get_drag_data_fw"> - <return type="Variant"> - </return> - <argument index="0" name="point" type="Vector2"> - </argument> - <argument index="1" name="from" type="Control"> - </argument> - <description> - </description> - </method> <method name="get_open_script_editors" qualifiers="const"> <return type="Array"> </return> diff --git a/doc/classes/ScriptEditorBase.xml b/doc/classes/ScriptEditorBase.xml index e5c4c32450..a135062bd8 100644 --- a/doc/classes/ScriptEditorBase.xml +++ b/doc/classes/ScriptEditorBase.xml @@ -9,7 +9,7 @@ <tutorials> </tutorials> <methods> - <method name="add_syntax_highlighter" qualifiers="virtual"> + <method name="_add_syntax_highlighter" qualifiers="virtual"> <return type="void"> </return> <argument index="0" name="highlighter" type="Object"> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index f311e1c72f..e8b405e52a 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Semaphore" inherits="Reference" version="4.0"> +<class name="Semaphore" inherits="RefCounted" version="4.0"> <brief_description> A synchronization semaphore. </brief_description> diff --git a/doc/classes/SkeletonIK3D.xml b/doc/classes/SkeletonIK3D.xml index 5949ad54fd..dccc45d0ec 100644 --- a/doc/classes/SkeletonIK3D.xml +++ b/doc/classes/SkeletonIK3D.xml @@ -46,13 +46,13 @@ </member> <member name="override_tip_basis" type="bool" setter="set_override_tip_basis" getter="is_override_tip_basis" default="true"> </member> - <member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="@"""> + <member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="&"""> </member> <member name="target" type="Transform3D" setter="set_target_transform" getter="get_target_transform" default="Transform3D( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </member> <member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath("")"> </member> - <member name="tip_bone" type="StringName" setter="set_tip_bone" getter="get_tip_bone" default="@"""> + <member name="tip_bone" type="StringName" setter="set_tip_bone" getter="get_tip_bone" default="&"""> </member> <member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet" default="false"> </member> diff --git a/doc/classes/SkinReference.xml b/doc/classes/SkinReference.xml index 8fc163f88d..3f8bc3be82 100644 --- a/doc/classes/SkinReference.xml +++ b/doc/classes/SkinReference.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SkinReference" inherits="Reference" version="4.0"> +<class name="SkinReference" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index a7d61a6bab..8c4b9e7d10 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -39,6 +39,11 @@ Emitted when the [member frame] changes. </description> </signal> + <signal name="texture_changed"> + <description> + Emitted when the [member texture] changes. + </description> + </signal> </signals> <constants> </constants> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index f120103916..5367a572f1 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="StreamPeer" inherits="Reference" version="4.0"> +<class name="StreamPeer" inherits="RefCounted" version="4.0"> <brief_description> Abstraction and base class for stream-based protocols. </brief_description> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index a81defa16c..d0c5f0ea86 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -275,7 +275,7 @@ Returns a copy of the string with the substring [code]what[/code] inserted at the given position. </description> </method> - <method name="is_abs_path" qualifiers="const"> + <method name="is_absolute_path" qualifiers="const"> <return type="bool"> </return> <description> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 895d0c357d..f4a1f1f01d 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -127,13 +127,6 @@ The texture to use when drawing this style box. </member> </members> - <signals> - <signal name="texture_changed"> - <description> - Emitted when the stylebox's texture is changed. - </description> - </signal> - </signals> <constants> <constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode"> Stretch the stylebox's texture. This results in visible distortion unless the texture size matches the stylebox's size perfectly. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index d434f5c2c9..56b47f4a24 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SurfaceTool" inherits="Reference" version="4.0"> +<class name="SurfaceTool" inherits="RefCounted" version="4.0"> <brief_description> Helper tool to create geometry. </brief_description> diff --git a/doc/classes/TCPServer.xml b/doc/classes/TCPServer.xml index 28f06ad3ae..7160055c6d 100644 --- a/doc/classes/TCPServer.xml +++ b/doc/classes/TCPServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TCPServer" inherits="Reference" version="4.0"> +<class name="TCPServer" inherits="RefCounted" version="4.0"> <brief_description> A TCP server. </brief_description> diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml index c21da09edb..ddbae0e977 100644 --- a/doc/classes/TextLine.xml +++ b/doc/classes/TextLine.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextLine" inherits="Reference" version="4.0"> +<class name="TextLine" inherits="RefCounted" version="4.0"> <brief_description> Holds a line of text. </brief_description> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index 8df53b8423..e9afe47ee8 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextParagraph" inherits="Reference" version="4.0"> +<class name="TextParagraph" inherits="RefCounted" version="4.0"> <brief_description> Holds a paragraph of text. </brief_description> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 88f46e3937..5ac9416b72 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Thread" inherits="Reference" version="4.0"> +<class name="Thread" inherits="RefCounted" version="4.0"> <brief_description> A unit of execution in a process. </brief_description> diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml new file mode 100644 index 0000000000..0c7c090e97 --- /dev/null +++ b/doc/classes/Time.xml @@ -0,0 +1,270 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Time" inherits="Object" version="4.0"> + <brief_description> + Time singleton for working with time. + </brief_description> + <description> + 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. + [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> + </tutorials> + <methods> + <method name="get_date_dict_from_system" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], and [code]dst[/code] (Daylight Savings Time). + The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. + </description> + </method> + <method name="get_date_dict_from_unix_time" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. + </description> + </method> + <method name="get_date_string_from_system" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns the current date as an ISO 8601 date string (YYYY-MM-DD). + The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. + </description> + </method> + <method name="get_date_string_from_unix_time" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Converts the given Unix timestamp to an ISO 8601 date string (YYYY-MM-DD). + </description> + </method> + <method name="get_datetime_dict_from_string" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="datetime" type="String"> + </argument> + <argument index="1" name="weekday" type="bool"> + </argument> + <description> + Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. + If [code]weekday[/code] is false, then the [code]weekday[/code] entry is excluded (the calculation is relatively expensive). + </description> + </method> + <method name="get_datetime_dict_from_system" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. + </description> + </method> + <method name="get_datetime_dict_from_unix_time" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Converts the given Unix timestamp to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]. + The returned Dictionary's values will be the same as the [method get_datetime_dict_from_system] if the Unix timestamp is the current time, with the exception of Daylight Savings Time as it cannot be determined from the epoch. + </description> + </method> + <method name="get_datetime_string_from_dict" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="datetime" type="Dictionary"> + </argument> + <argument index="1" name="use_space" type="bool"> + </argument> + <description> + Converts the given dictionary of keys to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). + 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). + If [code]use_space[/code] is true, use a space instead of the letter T in the middle. + </description> + </method> + <method name="get_datetime_string_from_system" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <argument index="1" name="use_space" type="bool" default="false"> + </argument> + <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]. + 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> + </method> + <method name="get_datetime_string_from_unix_time" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <argument index="1" name="use_space" type="bool" default="false"> + </argument> + <description> + Converts the given Unix timestamp to an ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS). + If [code]use_space[/code] is true, use a space instead of the letter T in the middle. + </description> + </method> + <method name="get_ticks_msec" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of time passed in milliseconds since the engine started. + </description> + </method> + <method name="get_ticks_usec" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of time passed in microseconds since the engine started. + </description> + </method> + <method name="get_time_dict_from_system" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns the current time as a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. + The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. + </description> + </method> + <method name="get_time_dict_from_unix_time" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Converts the given time to a dictionary of keys: [code]hour[/code], [code]minute[/code], and [code]second[/code]. + </description> + </method> + <method name="get_time_string_from_system" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns the current time as an ISO 8601 time string (HH:MM:SS). + The returned values are in the system's local time when [code]utc[/code] is false, otherwise they are in UTC. + </description> + </method> + <method name="get_time_string_from_unix_time" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Converts the given Unix timestamp to an ISO 8601 time string (HH:MM:SS). + </description> + </method> + <method name="get_time_zone_from_system" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns the current time zone as a dictionary of keys: [code]bias[/code] and [code]name[/code]. The [code]bias[/code] value is the offset from UTC in minutes, since not all time zones are multiples of an hour from UTC. + </description> + </method> + <method name="get_unix_time_from_datetime_dict" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="datetime" type="Dictionary"> + </argument> + <description> + Converts a dictionary of time values to a Unix timestamp. + 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. + </description> + </method> + <method name="get_unix_time_from_datetime_string" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="datetime" type="String"> + </argument> + <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. + </description> + </method> + <method name="get_unix_time_from_system" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the current Unix timestamp in seconds based on the system time. + </description> + </method> + </methods> + <constants> + <constant name="MONTH_JANUARY" value="1" enum="Month"> + The month of January, represented numerically as [code]01[/code]. + </constant> + <constant name="MONTH_FEBRUARY" value="2" enum="Month"> + The month of February, represented numerically as [code]02[/code]. + </constant> + <constant name="MONTH_MARCH" value="3" enum="Month"> + The month of March, represented numerically as [code]03[/code]. + </constant> + <constant name="MONTH_APRIL" value="4" enum="Month"> + The month of April, represented numerically as [code]04[/code]. + </constant> + <constant name="MONTH_MAY" value="5" enum="Month"> + The month of May, represented numerically as [code]05[/code]. + </constant> + <constant name="MONTH_JUNE" value="6" enum="Month"> + The month of June, represented numerically as [code]06[/code]. + </constant> + <constant name="MONTH_JULY" value="7" enum="Month"> + The month of July, represented numerically as [code]07[/code]. + </constant> + <constant name="MONTH_AUGUST" value="8" enum="Month"> + The month of August, represented numerically as [code]08[/code]. + </constant> + <constant name="MONTH_SEPTEMBER" value="9" enum="Month"> + The month of September, represented numerically as [code]09[/code]. + </constant> + <constant name="MONTH_OCTOBER" value="10" enum="Month"> + The month of October, represented numerically as [code]10[/code]. + </constant> + <constant name="MONTH_NOVEMBER" value="11" enum="Month"> + The month of November, represented numerically as [code]11[/code]. + </constant> + <constant name="MONTH_DECEMBER" value="12" enum="Month"> + The month of December, represented numerically as [code]12[/code]. + </constant> + <constant name="WEEKDAY_SUNDAY" value="0" enum="Weekday"> + The day of the week Sunday, represented numerically as [code]0[/code]. + </constant> + <constant name="WEEKDAY_MONDAY" value="1" enum="Weekday"> + The day of the week Monday, represented numerically as [code]1[/code]. + </constant> + <constant name="WEEKDAY_TUESDAY" value="2" enum="Weekday"> + The day of the week Tuesday, represented numerically as [code]2[/code]. + </constant> + <constant name="WEEKDAY_WEDNESDAY" value="3" enum="Weekday"> + The day of the week Wednesday, represented numerically as [code]3[/code]. + </constant> + <constant name="WEEKDAY_THURSDAY" value="4" enum="Weekday"> + The day of the week Thursday, represented numerically as [code]4[/code]. + </constant> + <constant name="WEEKDAY_FRIDAY" value="5" enum="Weekday"> + The day of the week Friday, represented numerically as [code]5[/code]. + </constant> + <constant name="WEEKDAY_SATURDAY" value="6" enum="Weekday"> + The day of the week Saturday, represented numerically as [code]6[/code]. + </constant> + </constants> +</class> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index c31467c67e..fe83bf9c2d 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -361,7 +361,7 @@ The number of columns. </member> <member name="drop_mode_flags" type="int" setter="set_drop_mode_flags" getter="get_drop_mode_flags" default="0"> - The drop mode as an OR combination of flags. See [enum DropModeFlags] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control.can_drop_data] is recommended. + The drop mode as an OR combination of flags. See [enum DropModeFlags] constants. Once dropping is done, reverts to [constant DROP_MODE_DISABLED]. Setting this during [method Control._can_drop_data] is recommended. This controls the drop sections, i.e. the decision and drawing of possible drop locations based on the mouse position. </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" override="true" enum="Control.FocusMode" default="2" /> diff --git a/doc/classes/TriangleMesh.xml b/doc/classes/TriangleMesh.xml index 39bee0c2b3..cfdb6fe33e 100644 --- a/doc/classes/TriangleMesh.xml +++ b/doc/classes/TriangleMesh.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TriangleMesh" inherits="Reference" version="4.0"> +<class name="TriangleMesh" inherits="RefCounted" version="4.0"> <brief_description> Internal mesh type. </brief_description> diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 6f3ccb8a17..5e2906450c 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="UDPServer" inherits="Reference" version="4.0"> +<class name="UDPServer" inherits="RefCounted" version="4.0"> <brief_description> Helper class to implement a UDP server. </brief_description> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml index 775bd58bcf..240c1c909f 100644 --- a/doc/classes/Variant.xml +++ b/doc/classes/Variant.xml @@ -5,20 +5,30 @@ </brief_description> <description> In computer programming, a Variant class is a class that is designed to store a variety of other types. Dynamic programming languages like PHP, Lua, JavaScript and GDScript like to use them to store variables' data on the backend. With these Variants, properties are able to change value types freely. - [codeblock] + [codeblocks] + [gdscript] var foo = 2 # foo is dynamically an integer foo = "Now foo is a string!" - foo = Reference.new() # foo is an Object + foo = RefCounted.new() # foo is an Object var bar: int = 2 # bar is a statically typed integer. # bar = "Uh oh! I can't make static variables become a different type!" - [/codeblock] + [/gdscript] + [csharp] + // ... but C# is statically typed. Once a variable has a type it cannot be changed. However you can use the var keyword in methods to let the compiler decide the type automatically. + var foo = 2; // Foo is a 32-bit integer (int). Be cautious, integers in GDScript are 64-bit and the direct C# equivalent is "long". + // foo = "foo was and will always be an integer. It cannot be turned into a string!"; + var boo = "Boo is a string!"; + var ref = new Reference(); // var is especially useful when used together with a constructor. + [/csharp] + [/codeblocks] Godot tracks all scripting API variables within Variants. Without even realizing it, you use Variants all the time. When a particular language enforces its own rules for keeping data typed, then that language is applying its own custom logic over the base Variant scripting API. - GDScript automatically wrap values in them. It keeps all data in plain Variants by default and then optionally enforces custom static typing rules on variable types. - VisualScript tracks properties inside Variants as well, but it also uses static typing. The GUI interface enforces that properties have a particular type that doesn't change over time. - C# is statically typed, but uses the Mono [code]object[/code] type in place of Godot's Variant class when it needs to represent a dynamic value. [code]object[/code] is the Mono runtime's equivalent of the same concept. - The statically-typed language NativeScript C++ does not define a built-in Variant-like class. Godot's GDNative bindings provide their own godot::Variant class for users; Any point at which the C++ code starts interacting with the Godot runtime is a place where you might have to start wrapping data inside Variant objects. The global [method @GlobalScope.typeof] function returns the enumerated value of the Variant type stored in the current variable (see [enum Variant.Type]). - [codeblock] + [codeblocks] + [gdscript] var foo = 2 match typeof(foo): TYPE_NIL: @@ -32,7 +42,19 @@ # Note also that there is not yet any way to get a script's `class_name` string easily. # To fetch that value, you need to dig deeply into a hidden ProjectSettings setting: an Array of Dictionaries called "_global_script_classes". # Open your project.godot file to see it up close. - [/codeblock] + [/gdscript] + [csharp] + int foo = 2; + if (foo == null) + { + GD.Print("foo is null"); + } + if (foo is int) + { + GD.Print("foo is an integer"); + } + [/csharp] + [/codeblocks] A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time. Instead, they are used mainly for communication, editing, serialization and moving data around. Godot has specifically invested in making its Variant class as flexible as possible; so much so that it is used for a multitude of operations to facilitate communication between all of Godot's systems. A Variant: diff --git a/doc/classes/VelocityTracker3D.xml b/doc/classes/VelocityTracker3D.xml index 98f7533c76..2d5e3a4d30 100644 --- a/doc/classes/VelocityTracker3D.xml +++ b/doc/classes/VelocityTracker3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VelocityTracker3D" inherits="Reference" version="4.0"> +<class name="VelocityTracker3D" inherits="RefCounted" version="4.0"> <brief_description> </brief_description> <description> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index d905ce4054..12558ebbbc 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -60,7 +60,7 @@ <member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec" default="500"> Amount of time in milliseconds to store in buffer while playing. </member> - <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master""> + <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master""> Audio bus to use for sound playback. </member> <member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 7f05b14765..96d63b27ad 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -81,10 +81,16 @@ <description> Returns the viewport's texture. [b]Note:[/b] Due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture2D.get_image] to flip it back, for example: - [codeblock] + [codeblocks] + [gdscript] var img = get_viewport().get_texture().get_image() img.flip_y() - [/codeblock] + [/gdscript] + [csharp] + Image img = GetViewport().GetTexture().GetImage(); + img.FlipY(); + [/csharp] + [/codeblocks] </description> </method> <method name="get_viewport_rid" qualifiers="const"> @@ -105,7 +111,7 @@ <return type="Variant"> </return> <description> - Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + Returns the drag data from the GUI, that was previously returned by [method Control._get_drag_data]. </description> </method> <method name="gui_is_dragging" qualifiers="const"> diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index ff00a848b9..775ac88eff 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -222,15 +222,19 @@ <constant name="TYPE_LIGHT" value="2" enum="Type"> A shader for light calculations. </constant> - <constant name="TYPE_EMIT" value="3" enum="Type"> + <constant name="TYPE_START" value="3" enum="Type"> </constant> <constant name="TYPE_PROCESS" value="4" enum="Type"> </constant> - <constant name="TYPE_END" value="5" enum="Type"> + <constant name="TYPE_COLLIDE" value="5" enum="Type"> </constant> - <constant name="TYPE_SKY" value="6" enum="Type"> + <constant name="TYPE_START_CUSTOM" value="6" enum="Type"> </constant> - <constant name="TYPE_MAX" value="7" enum="Type"> + <constant name="TYPE_PROCESS_CUSTOM" value="7" enum="Type"> + </constant> + <constant name="TYPE_SKY" value="8" enum="Type"> + </constant> + <constant name="TYPE_MAX" value="9" enum="Type"> Represents the size of the [enum Type] enum. </constant> <constant name="NODE_ID_INVALID" value="-1"> diff --git a/doc/classes/VisualShaderNodeParticleAccelerator.xml b/doc/classes/VisualShaderNodeParticleAccelerator.xml new file mode 100644 index 0000000000..82aae1df63 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleAccelerator.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleAccelerator" inherits="VisualShaderNodeOutput" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="VisualShaderNodeParticleAccelerator.Mode" default="0"> + </member> + </members> + <constants> + <constant name="MODE_LINEAR" value="0" enum="Mode"> + </constant> + <constant name="MODE_RADIAL" value="1" enum="Mode"> + </constant> + <constant name="MODE_TANGENTIAL" value="2" enum="Mode"> + </constant> + <constant name="MODE_MAX" value="3" enum="Mode"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleBoxEmitter.xml b/doc/classes/VisualShaderNodeParticleBoxEmitter.xml new file mode 100644 index 0000000000..af33b285d2 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleBoxEmitter.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleBoxEmitter" inherits="VisualShaderNodeParticleEmitter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleConeVelocity.xml b/doc/classes/VisualShaderNodeParticleConeVelocity.xml new file mode 100644 index 0000000000..7a40c2a7d0 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleConeVelocity.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleConeVelocity" inherits="VisualShaderNode" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleEmit.xml b/doc/classes/VisualShaderNodeParticleEmit.xml new file mode 100644 index 0000000000..120b12d643 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleEmit.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleEmit" inherits="VisualShaderNode" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="flags" type="int" setter="set_flags" getter="get_flags" enum="VisualShaderNodeParticleEmit.EmitFlags" default="31"> + </member> + </members> + <constants> + <constant name="EMIT_FLAG_POSITION" value="1" enum="EmitFlags"> + </constant> + <constant name="EMIT_FLAG_ROT_SCALE" value="2" enum="EmitFlags"> + </constant> + <constant name="EMIT_FLAG_VELOCITY" value="4" enum="EmitFlags"> + </constant> + <constant name="EMIT_FLAG_COLOR" value="8" enum="EmitFlags"> + </constant> + <constant name="EMIT_FLAG_CUSTOM" value="16" enum="EmitFlags"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleEmitter.xml b/doc/classes/VisualShaderNodeParticleEmitter.xml new file mode 100644 index 0000000000..3a25fc1c7f --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleEmitter.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleEmitter" inherits="VisualShaderNode" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleMultiplyByAxisAngle.xml b/doc/classes/VisualShaderNodeParticleMultiplyByAxisAngle.xml new file mode 100644 index 0000000000..89a53699c9 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleMultiplyByAxisAngle.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleMultiplyByAxisAngle" inherits="VisualShaderNode" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="degrees_mode" type="bool" setter="set_degrees_mode" getter="is_degrees_mode" default="true"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleOutput.xml b/doc/classes/VisualShaderNodeParticleOutput.xml new file mode 100644 index 0000000000..c8fc66f2ff --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleOutput.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleOutput" inherits="VisualShaderNodeOutput" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleRandomness.xml b/doc/classes/VisualShaderNodeParticleRandomness.xml new file mode 100644 index 0000000000..f19723a663 --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleRandomness.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleRandomness" inherits="VisualShaderNode" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="op_type" type="int" setter="set_op_type" getter="get_op_type" enum="VisualShaderNodeParticleRandomness.OpType" default="0"> + </member> + </members> + <constants> + <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> + </constant> + <constant name="OP_TYPE_VECTOR" value="1" enum="OpType"> + </constant> + <constant name="OP_TYPE_MAX" value="2" enum="OpType"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleRingEmitter.xml b/doc/classes/VisualShaderNodeParticleRingEmitter.xml new file mode 100644 index 0000000000..ee3fbe7faf --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleRingEmitter.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleRingEmitter" inherits="VisualShaderNodeParticleEmitter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeParticleSphereEmitter.xml b/doc/classes/VisualShaderNodeParticleSphereEmitter.xml new file mode 100644 index 0000000000..d43ac518cf --- /dev/null +++ b/doc/classes/VisualShaderNodeParticleSphereEmitter.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeParticleSphereEmitter" inherits="VisualShaderNodeParticleEmitter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 4140df5828..6c9a7de67f 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="WeakRef" inherits="Reference" version="4.0"> +<class name="WeakRef" inherits="RefCounted" version="4.0"> <brief_description> Holds an [Object], but does not contribute to the reference count if the object is a reference. </brief_description> <description> - A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. + A weakref can hold a [RefCounted], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. </description> <tutorials> </tutorials> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 37709753bc..9c320747d1 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -340,7 +340,7 @@ </member> <member name="theme" type="Theme" setter="set_theme" getter="get_theme"> </member> - <member name="theme_custom_type" type="StringName" setter="set_theme_custom_type" getter="get_theme_custom_type" default="@"""> + <member name="theme_custom_type" type="StringName" setter="set_theme_custom_type" getter="get_theme_custom_type" default="&"""> </member> <member name="title" type="String" setter="set_title" getter="get_title" default=""""> </member> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 2849ea62ab..ab5c58c51c 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XMLParser" inherits="Reference" version="4.0"> +<class name="XMLParser" inherits="RefCounted" version="4.0"> <brief_description> Low-level class for creating parsers for [url=https://en.wikipedia.org/wiki/XML]XML[/url] files. </brief_description> diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 034cb51be3..fec98007c3 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XRInterface" inherits="Reference" version="4.0"> +<class name="XRInterface" inherits="RefCounted" version="4.0"> <brief_description> Base class for an AR/VR interface implementation. </brief_description> @@ -46,6 +46,13 @@ If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. </description> </method> + <method name="get_view_count"> + <return type="int"> + </return> + <description> + Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic. + </description> + </method> <method name="initialize"> <return type="bool"> </return> @@ -57,13 +64,6 @@ While currently not used, you can activate additional interfaces. You may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD. </description> </method> - <method name="is_stereo"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the current output of this interface is in stereo. - </description> - </method> <method name="uninitialize"> <return type="void"> </return> diff --git a/doc/classes/XRPositionalTracker.xml b/doc/classes/XRPositionalTracker.xml index 2cf8e1d6f5..cd8cb71cd9 100644 --- a/doc/classes/XRPositionalTracker.xml +++ b/doc/classes/XRPositionalTracker.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="XRPositionalTracker" inherits="Reference" version="4.0"> +<class name="XRPositionalTracker" inherits="RefCounted" version="4.0"> <brief_description> A tracked object. </brief_description> diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 8284fa4a89..149e177700 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -96,7 +96,7 @@ <return type="int"> </return> <description> - Returns the absolute timestamp (in μs) of the last [XRServer] commit of the AR/VR eyes to [RenderingServer]. The value comes from an internal call to [method OS.get_ticks_usec]. + Returns the absolute timestamp (in μs) of the last [XRServer] commit of the AR/VR eyes to [RenderingServer]. The value comes from an internal call to [method Time.get_ticks_usec]. </description> </method> <method name="get_last_frame_usec"> @@ -110,7 +110,7 @@ <return type="int"> </return> <description> - Returns the absolute timestamp (in μs) of the last [XRServer] process callback. The value comes from an internal call to [method OS.get_ticks_usec]. + Returns the absolute timestamp (in μs) of the last [XRServer] process callback. The value comes from an internal call to [method Time.get_ticks_usec]. </description> </method> <method name="get_reference_frame" qualifiers="const"> diff --git a/doc/translations/ar.po b/doc/translations/ar.po index b4ae664714..77a3d39f27 100644 --- a/doc/translations/ar.po +++ b/doc/translations/ar.po @@ -33036,7 +33036,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33055,12 +33055,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34557,7 +34557,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41765,30 +41765,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41796,7 +41796,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54060,7 +54060,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59139,7 +59139,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/ca.po b/doc/translations/ca.po index 6485111b20..8ea801181d 100644 --- a/doc/translations/ca.po +++ b/doc/translations/ca.po @@ -33067,7 +33067,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33086,12 +33086,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34588,7 +34588,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41796,30 +41796,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41827,7 +41827,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54091,7 +54091,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59170,7 +59170,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/classes.pot b/doc/translations/classes.pot index d14b0d9b1f..d12fa78b0e 100644 --- a/doc/translations/classes.pot +++ b/doc/translations/classes.pot @@ -33037,7 +33037,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33056,12 +33056,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34558,7 +34558,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41766,30 +41766,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41797,7 +41797,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54061,7 +54061,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59140,7 +59140,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/cs.po b/doc/translations/cs.po index 7b958a5049..a267656497 100644 --- a/doc/translations/cs.po +++ b/doc/translations/cs.po @@ -33536,7 +33536,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33555,12 +33555,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -35058,7 +35058,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42266,30 +42266,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42297,7 +42297,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54562,7 +54562,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59645,7 +59645,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/de.po b/doc/translations/de.po index 2e3e219ba6..181d64d525 100644 --- a/doc/translations/de.po +++ b/doc/translations/de.po @@ -33453,7 +33453,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33472,12 +33472,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 #, fuzzy msgid "" @@ -34984,7 +34984,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42226,30 +42226,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42257,7 +42257,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54558,7 +54558,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59796,7 +59796,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/es.po b/doc/translations/es.po index 3078c1bf90..7df36316b7 100644 --- a/doc/translations/es.po +++ b/doc/translations/es.po @@ -44834,7 +44834,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -44853,9 +44853,9 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" "Toda clase que no es un tipo integrado hereda de esta clase.\n" "Puedes construir Objetos desde lenguajes de scripting, usando [code]Object." @@ -44866,7 +44866,7 @@ msgstr "" "llama al método [method free] desde tu script o elimina la instancia desde C+" "+.\n" "Algunas clases que extienden a Object añaden gestión de memoria. Este es el " -"caso de [Reference], que cuenta las referencias y se borra a sà misma " +"caso de [RefCounted], que cuenta las referencias y se borra a sà misma " "automáticamente cuando deja de estar referenciada. [Node], otro tipo " "fundamental, borra todos sus hijos cuando se libera de la memoria.\n" "Los objetos exportan propiedades, que son principalmente útiles para el " @@ -44887,7 +44887,7 @@ msgstr "" "sencilla de notificar al objeto sobre diferentes eventos, de modo que todos " "ellos pueden ser manejados juntos. Véase [method _notification]." -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 #, fuzzy msgid "" @@ -46525,7 +46525,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -53779,30 +53779,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -53810,7 +53810,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -66189,7 +66189,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -71348,7 +71348,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/fa.po b/doc/translations/fa.po index 733d3bb969..e440146dd3 100644 --- a/doc/translations/fa.po +++ b/doc/translations/fa.po @@ -33042,7 +33042,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33061,12 +33061,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34563,7 +34563,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41771,30 +41771,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41802,7 +41802,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54066,7 +54066,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59145,7 +59145,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/fi.po b/doc/translations/fi.po index 0a40863a52..92ec4f29dd 100644 --- a/doc/translations/fi.po +++ b/doc/translations/fi.po @@ -33055,7 +33055,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33074,12 +33074,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34576,7 +34576,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41784,30 +41784,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41815,7 +41815,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54080,7 +54080,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59168,7 +59168,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/fr.po b/doc/translations/fr.po index f3e26ebc61..7717474c0f 100644 --- a/doc/translations/fr.po +++ b/doc/translations/fr.po @@ -33403,7 +33403,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33422,12 +33422,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34927,7 +34927,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42142,30 +42142,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42173,7 +42173,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54519,7 +54519,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59618,7 +59618,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/id.po b/doc/translations/id.po index 1bce3d6b50..edfd392f4f 100644 --- a/doc/translations/id.po +++ b/doc/translations/id.po @@ -33068,7 +33068,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33087,12 +33087,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34589,7 +34589,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41797,30 +41797,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41828,7 +41828,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54092,7 +54092,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59171,7 +59171,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/it.po b/doc/translations/it.po index 18e162476c..353eae4116 100644 --- a/doc/translations/it.po +++ b/doc/translations/it.po @@ -33334,7 +33334,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33353,12 +33353,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34856,7 +34856,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42067,30 +42067,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42098,7 +42098,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54365,7 +54365,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59459,7 +59459,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/ja.po b/doc/translations/ja.po index ede80a35ef..1424b24153 100644 --- a/doc/translations/ja.po +++ b/doc/translations/ja.po @@ -34306,7 +34306,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -34325,12 +34325,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 #, fuzzy msgid "" @@ -35830,7 +35830,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -43046,30 +43046,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -43077,7 +43077,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -55349,7 +55349,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -60446,7 +60446,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/ko.po b/doc/translations/ko.po index e71cd06ba7..8e8aef2eaf 100644 --- a/doc/translations/ko.po +++ b/doc/translations/ko.po @@ -33044,7 +33044,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33063,12 +33063,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34565,7 +34565,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41773,30 +41773,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41804,7 +41804,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54068,7 +54068,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59149,7 +59149,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/nl.po b/doc/translations/nl.po index 032ff95bdb..096e59f497 100644 --- a/doc/translations/nl.po +++ b/doc/translations/nl.po @@ -33070,7 +33070,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33089,12 +33089,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34591,7 +34591,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41799,30 +41799,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41830,7 +41830,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54094,7 +54094,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59173,7 +59173,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/pl.po b/doc/translations/pl.po index b0c94b55be..5ef41b155a 100644 --- a/doc/translations/pl.po +++ b/doc/translations/pl.po @@ -33089,7 +33089,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33108,12 +33108,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34610,7 +34610,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41818,30 +41818,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41849,7 +41849,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54117,7 +54117,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59203,7 +59203,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/pt_BR.po b/doc/translations/pt_BR.po index a508d38859..ef62950d51 100644 --- a/doc/translations/pt_BR.po +++ b/doc/translations/pt_BR.po @@ -33083,7 +33083,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33102,12 +33102,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34604,7 +34604,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41812,30 +41812,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41843,7 +41843,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54108,7 +54108,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59194,7 +59194,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/ro.po b/doc/translations/ro.po index 96c0161312..5f018aa497 100644 --- a/doc/translations/ro.po +++ b/doc/translations/ro.po @@ -33044,7 +33044,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33063,12 +33063,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34565,7 +34565,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41773,30 +41773,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41804,7 +41804,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54068,7 +54068,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59147,7 +59147,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/ru.po b/doc/translations/ru.po index 1108967bc9..0d227beff7 100644 --- a/doc/translations/ru.po +++ b/doc/translations/ru.po @@ -33581,7 +33581,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33600,12 +33600,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -35104,7 +35104,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42362,30 +42362,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42393,7 +42393,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54666,7 +54666,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59891,7 +59891,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/sr_Cyrl.po b/doc/translations/sr_Cyrl.po index d7d2911b97..d53711d996 100644 --- a/doc/translations/sr_Cyrl.po +++ b/doc/translations/sr_Cyrl.po @@ -33054,7 +33054,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33073,12 +33073,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34575,7 +34575,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41783,30 +41783,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41814,7 +41814,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54078,7 +54078,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59157,7 +59157,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/th.po b/doc/translations/th.po index 5031ecfb0e..7686e22f19 100644 --- a/doc/translations/th.po +++ b/doc/translations/th.po @@ -33060,7 +33060,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33079,12 +33079,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34581,7 +34581,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41789,30 +41789,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41820,7 +41820,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54084,7 +54084,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59163,7 +59163,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/tr.po b/doc/translations/tr.po index a317f4ee83..df9897f1d6 100644 --- a/doc/translations/tr.po +++ b/doc/translations/tr.po @@ -33036,7 +33036,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33055,12 +33055,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34557,7 +34557,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41765,30 +41765,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41796,7 +41796,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54060,7 +54060,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59139,7 +59139,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/uk.po b/doc/translations/uk.po index 8ca75e8b19..d1296da87a 100644 --- a/doc/translations/uk.po +++ b/doc/translations/uk.po @@ -33122,7 +33122,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33141,12 +33141,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34643,7 +34643,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41851,30 +41851,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41882,7 +41882,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54147,7 +54147,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59237,7 +59237,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/zh_Hans.po b/doc/translations/zh_Hans.po index aee852699c..edfb11dec1 100644 --- a/doc/translations/zh_Hans.po +++ b/doc/translations/zh_Hans.po @@ -33272,7 +33272,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33291,12 +33291,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34794,7 +34794,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -42002,30 +42002,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -42033,7 +42033,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54298,7 +54298,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59381,7 +59381,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " diff --git a/doc/translations/zh_Hant.po b/doc/translations/zh_Hant.po index 242c8cc086..3afec7ead8 100644 --- a/doc/translations/zh_Hant.po +++ b/doc/translations/zh_Hant.po @@ -33073,7 +33073,7 @@ msgid "" "to delete instances of it manually. To do so, call the [method free] method " "from your script or delete the instance from C++.\n" "Some classes that extend Object add memory management. This is the case of " -"[Reference], which counts references and deletes itself automatically when " +"[RefCounted], which counts references and deletes itself automatically when " "no longer referenced. [Node], another fundamental type, deletes all its " "children when freed from memory.\n" "Objects export properties, which are mainly useful for storage and editing, " @@ -33092,12 +33092,12 @@ msgid "" "Objects also receive notifications. Notifications are a simple way to notify " "the object about different events, so they can all be handled together. See " "[method _notification].\n" -"[b]Note:[/b] Unlike references to a [Reference], references to an Object " +"[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 [Reference] for data classes instead of [Object]." +"recommended to use [RefCounted] for data classes instead of [Object]." msgstr "" -#: doc/classes/Object.xml:23 doc/classes/Reference.xml:12 +#: doc/classes/Object.xml:23 doc/classes/RefCounted.xml:12 #: doc/classes/Resource.xml:11 msgid "" "https://docs.godotengine.org/en/latest/getting_started/workflow/" @@ -34594,7 +34594,7 @@ msgid "Changes the [Color] at the given index." msgstr "" #: doc/classes/PackedDataContainerRef.xml:4 -msgid "Reference version of [PackedDataContainer]." +msgid "RefCounted version of [PackedDataContainer]." msgstr "" #: doc/classes/PackedFloat32Array.xml:4 @@ -41802,30 +41802,30 @@ msgid "" "the half extents." msgstr "" -#: doc/classes/Reference.xml:4 +#: doc/classes/RefCounted.xml:4 msgid "Base class for reference-counted objects." msgstr "" -#: doc/classes/Reference.xml:7 +#: doc/classes/RefCounted.xml:7 msgid "" "Base class for any object that keeps a reference count. [Resource] and many " "other helper objects inherit this class.\n" "Unlike [Object]s, 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].\n" -"In the vast majority of use cases, instantiating and using [Reference]-" +"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." msgstr "" -#: doc/classes/Reference.xml:19 +#: doc/classes/RefCounted.xml:19 msgid "" "Initializes the internal reference counter. Use this only if you really know " "what you are doing.\n" "Returns whether the initialization was successful." msgstr "" -#: doc/classes/Reference.xml:27 +#: doc/classes/RefCounted.xml:27 msgid "" "Increments the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -41833,7 +41833,7 @@ msgid "" "code] otherwise." msgstr "" -#: doc/classes/Reference.xml:35 +#: doc/classes/RefCounted.xml:35 msgid "" "Decrements the internal reference counter. Use this only if you really know " "what you are doing.\n" @@ -54098,7 +54098,7 @@ msgid "" "[codeblock]\n" "var foo = 2 # foo is dynamically an integer\n" "foo = \"Now foo is a string!\"\n" -"foo = Reference.new() # foo is an Object\n" +"foo = RefCounted.new() # foo is an Object\n" "var bar: int = 2 # bar is a statically typed integer.\n" "# bar = \"Uh oh! I can't make static variables become a different type!\"\n" "[/codeblock]\n" @@ -59181,7 +59181,7 @@ msgstr "" #: doc/classes/WeakRef.xml:7 msgid "" -"A weakref can hold a [Reference], without contributing to the reference " +"A weakref can hold a [RefCounted], without contributing to the reference " "counter. A weakref can be created from an [Object] using [method @GDScript." "weakref]. If this object is not a reference, weakref still works, however, " "it does not have any effect on the object. Weakrefs are useful in cases " |