diff options
Diffstat (limited to 'doc/classes')
42 files changed, 418 insertions, 161 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index c753b341d2..df0cc6f268 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -32,12 +32,14 @@ <return type="Label" /> <description> Returns the label used for built-in text. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_ok_button"> <return type="Button" /> <description> Returns the OK [Button] instance. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="register_text_enter"> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index d2ecbdde26..ebcced7dc4 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -201,6 +201,14 @@ Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. </description> </method> + <method name="blend_shape_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="amount" type="float" /> + <description> + </description> + </method> <method name="clear"> <return type="void" /> <description> @@ -253,6 +261,14 @@ Returns the arguments values to be called on a method track for a given key in a given track. </description> </method> + <method name="position_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="position" type="Vector3" /> + <description> + </description> + </method> <method name="remove_track"> <return type="void" /> <argument index="0" name="track_idx" type="int" /> @@ -260,6 +276,22 @@ Removes a track by specifying the track index. </description> </method> + <method name="rotation_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="rotation" type="Quaternion" /> + <description> + </description> + </method> + <method name="scale_track_insert_key"> + <return type="int" /> + <argument index="0" name="track_idx" type="int" /> + <argument index="1" name="time" type="float" /> + <argument index="2" name="scale" type="Vector3" /> + <description> + </description> + </method> <method name="track_find_key" qualifiers="const"> <return type="int" /> <argument index="0" name="track_idx" type="int" /> @@ -466,25 +498,6 @@ Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. </description> </method> - <method name="transform_track_insert_key"> - <return type="int" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time" type="float" /> - <argument index="2" name="location" type="Vector3" /> - <argument index="3" name="rotation" type="Quaternion" /> - <argument index="4" name="scale" type="Vector3" /> - <description> - Insert a transform key for a transform track. - </description> - </method> - <method name="transform_track_interpolate" qualifiers="const"> - <return type="Array" /> - <argument index="0" name="track_idx" type="int" /> - <argument index="1" name="time_sec" type="float" /> - <description> - Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quaternion]) and scale ([Vector3]). - </description> - </method> <method name="value_track_get_key_indices" qualifiers="const"> <return type="PackedInt32Array" /> <argument index="0" name="track_idx" type="int" /> @@ -541,19 +554,24 @@ <constant name="TYPE_VALUE" value="0" enum="TrackType"> Value tracks set values in node properties, but only those which can be Interpolated. </constant> - <constant name="TYPE_TRANSFORM3D" value="1" enum="TrackType"> - Transform3D tracks are used to change node local transforms or skeleton pose bones of 3D nodes. Transitions are interpolated. + <constant name="TYPE_POSITION_3D" value="1" enum="TrackType"> + </constant> + <constant name="TYPE_ROTATION_3D" value="2" enum="TrackType"> + </constant> + <constant name="TYPE_SCALE_3D" value="3" enum="TrackType"> + </constant> + <constant name="TYPE_BLEND_SHAPE" value="4" enum="TrackType"> </constant> - <constant name="TYPE_METHOD" value="2" enum="TrackType"> + <constant name="TYPE_METHOD" value="5" enum="TrackType"> Method tracks call functions with given arguments per key. </constant> - <constant name="TYPE_BEZIER" value="3" enum="TrackType"> + <constant name="TYPE_BEZIER" value="6" enum="TrackType"> Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a [Color]). </constant> - <constant name="TYPE_AUDIO" value="4" enum="TrackType"> + <constant name="TYPE_AUDIO" value="7" enum="TrackType"> Audio tracks are used to play an audio stream with either type of [AudioStreamPlayer]. The stream can be trimmed and previewed in the animation. </constant> - <constant name="TYPE_ANIMATION" value="5" enum="TrackType"> + <constant name="TYPE_ANIMATION" value="8" enum="TrackType"> Animation tracks play animations in other [AnimationPlayer] nodes. </constant> <constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType"> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 3d112e258e..40dcd950d7 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -22,7 +22,7 @@ <method name="get_root_motion_transform" qualifiers="const"> <return type="Transform3D" /> <description> - Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. + Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_SCALE_3D] or [constant Animation.TYPE_ROTATION_3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. </description> </method> <method name="rename_parameter"> @@ -45,7 +45,7 @@ </member> <member name="root_motion_track" type="NodePath" setter="set_root_motion_track" getter="get_root_motion_track" default="NodePath("")"> The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. - If the track has type [constant Animation.TYPE_TRANSFORM3D], the transformation will be cancelled visually, and the animation will appear to stay in place. See also [method get_root_motion_transform] and [RootMotionView]. + If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be cancelled visually, and the animation will appear to stay in place. See also [method get_root_motion_transform] and [RootMotionView]. </member> <member name="tree_root" type="AnimationNode" setter="set_tree_root" getter="get_tree_root"> The root animation node of this [AnimationTree]. See [AnimationNode]. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 25f67f0571..ddfc3b1869 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -101,27 +101,27 @@ <signal name="area_shape_entered"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. + [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area[/code] the other Area2D. - [code]area_shape[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]area_shape_index[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="area_shape_exited"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area2D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. + [code]area_rid[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area[/code] the other Area2D. - [code]area_shape[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]area_shape_index[/code] the index of the [Shape2D] of the other Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_entered"> @@ -141,27 +141,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node2D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this Area2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> </signals> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index e91cfd79a1..896bfcd14e 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -120,27 +120,27 @@ <signal name="area_shape_entered"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. + [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area[/code] the other Area3D. - [code]area_shape[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]area_shape_index[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="area_shape_exited"> <argument index="0" name="area_rid" type="RID" /> <argument index="1" name="area" type="Area3D" /> - <argument index="2" name="area_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="area_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. - [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. + [code]area_rid[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area[/code] the other Area3D. - [code]area_shape[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]area_shape_index[/code] the index of the [Shape3D] of the other Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]area.shape_owner_get_owner(area_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_entered"> @@ -160,27 +160,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node3D" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this Area3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> </signals> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index bd344fad29..e8a78d5a4c 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -123,7 +123,7 @@ Logarithmic dampening of loudness according to distance. </constant> <constant name="ATTENUATION_DISABLED" value="3" enum="AttenuationModel"> - No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. + No dampening of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. [constant ATTENUATION_DISABLED] can be combined with a [member max_distance] value greater than [code]0.0[/code] to achieve linear attenuation clamped to a sphere of a defined size. </constant> <constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking"> Disables doppler tracking. diff --git a/doc/classes/CharFXTransform.xml b/doc/classes/CharFXTransform.xml index 2d8e7817c1..b11d9c341a 100644 --- a/doc/classes/CharFXTransform.xml +++ b/doc/classes/CharFXTransform.xml @@ -15,7 +15,7 @@ The color the character will be drawn with. </member> <member name="elapsed_time" type="float" setter="set_elapsed_time" getter="get_elapsed_time" default="0.0"> - The time elapsed since the [RichTextLabel] was added to the scene tree (in seconds). Time stops when the project is paused depending on the value of the [RichTextLabel]'s [member Node.process_mode]. + The time elapsed since the [RichTextLabel] was added to the scene tree (in seconds). Time stops when the [RichTextLabel] is paused (see [member Node.process_mode]). Resets when the text in the [RichTextLabel] is changed. [b]Note:[/b] Time still passes while the [RichTextLabel] is hidden. </member> <member name="env" type="Dictionary" setter="set_environment" getter="get_environment" default="{}"> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 1cdfbd760e..58b6e89507 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -17,12 +17,14 @@ <return type="ColorPicker" /> <description> Returns the [ColorPicker] that this node toggles. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_popup"> <return type="PopupPanel" /> <description> Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> </methods> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 352631da1d..c4bdaf436d 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -22,6 +22,7 @@ <return type="Button" /> <description> Returns the cancel button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> </methods> diff --git a/doc/classes/EditorDebuggerPlugin.xml b/doc/classes/EditorDebuggerPlugin.xml index 0773e176b3..6687d3c3ac 100644 --- a/doc/classes/EditorDebuggerPlugin.xml +++ b/doc/classes/EditorDebuggerPlugin.xml @@ -4,9 +4,10 @@ A base class to implement debugger plugins. </brief_description> <description> - All debugger plugin scripts must extend [EditorDebuggerPlugin]. It provides functions related to editor side of debugger. - You don't need to instantiate this class. That is handled by the debugger itself. [Control] nodes can be added as child nodes to provide a GUI front-end for the plugin. - Do not queue_free/reparent it's instance otherwise the instance becomes unusable. + [EditorDebuggerPlugin] provides functions related to the editor side of the debugger. + You don't need to instantiate this class; that is automatically handled by the debugger. [Control] nodes can be added as child nodes to provide a GUI for the plugin. + Do not free or reparent this node, otherwise it becomes unusable. + To use [EditorDebuggerPlugin], register it using the [method EditorPlugin.add_debugger_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index fca7bb350d..3830bfc60e 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -4,7 +4,8 @@ A script that is executed when exporting the project. </brief_description> <description> - Editor export plugins are automatically activated whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, [method _export_begin] is called at the beginning of the export process and then [method _export_file] is called for each exported file. + [EditorExportPlugin]s are automatically invoked whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, [method _export_begin] is called at the beginning of the export process and then [method _export_file] is called for each exported file. + To use [EditorExportPlugin], register it using the [method EditorPlugin.add_export_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index 53fba9f3b8..79758281ac 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -26,6 +26,7 @@ <return type="VBoxContainer" /> <description> Returns the [code]VBoxContainer[/code] used to display the file system. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="invalidate"> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index c5a44009d2..6011a5411d 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -4,7 +4,7 @@ Registers a custom resource importer in the editor. Use the class to parse any file and import it as a new resource type. </brief_description> <description> - EditorImportPlugins provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. Register your [EditorPlugin] with [method EditorPlugin.add_import_plugin]. + [EditorImportPlugin]s provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers. EditorImportPlugins work by associating with specific file extensions and a resource type. See [method _get_recognized_extensions] and [method _get_resource_type]. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the [code].godot/imported[/code] directory (see [member ProjectSettings.application/config/project_data_dir_name]). Below is an example EditorImportPlugin that imports a [Mesh] from a file with the extension ".special" or ".spec": [codeblocks] @@ -108,6 +108,7 @@ } [/csharp] [/codeblocks] + To use [EditorImportPlugin], register it using the [method EditorPlugin.add_import_plugin] method first. </description> <tutorials> <link title="Import plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/import_plugins.html</link> diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 17397b80bf..f65e974d47 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -4,13 +4,13 @@ Plugin for adding custom property editors on inspector. </brief_description> <description> - These plugins allow adding custom property editors to [EditorInspector]. - Plugins are registered via [method EditorPlugin.add_inspector_plugin]. + [EditorInspectorPlugin] allows adding custom property editors to [EditorInspector]. When an object is edited, the [method _can_handle] function is called and must return [code]true[/code] if the object type is supported. If supported, the function [method _parse_begin] will be called, allowing to place custom controls at the beginning of the class. Subsequently, the [method _parse_category] and [method _parse_property] are called for every category and property. They offer the ability to add custom controls to the inspector too. Finally, [method _parse_end] will be called. On each of these calls, the "add" functions can be called. + To use [EditorInspectorPlugin], register it using the [method EditorPlugin.add_inspector_plugin] method first. </description> <tutorials> <link title="Inspector plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/inspector_plugins.html</link> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index ad878aad80..5790d8c5af 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -28,12 +28,14 @@ <return type="Control" /> <description> Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. + [b]Warning:[/b] Removing and freeing this node will render the editor useless and may cause a crash. </description> </method> <method name="get_command_palette" qualifiers="const"> <return type="EditorCommandPalette" /> <description> Returns the editor's [EditorCommandPalette] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_current_path" qualifiers="const"> @@ -53,6 +55,7 @@ <description> Returns the main editor control. Use this as a parent for main screens. [b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_editor_paths"> @@ -77,12 +80,14 @@ <return type="FileSystemDock" /> <description> Returns the editor's [FileSystemDock] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_inspector" qualifiers="const"> <return type="EditorInspector" /> <description> Returns the editor's [EditorInspector] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_open_scenes" qualifiers="const"> @@ -113,6 +118,7 @@ <return type="ScriptEditor" /> <description> Returns the editor's [ScriptEditor] instance. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_selected_path" qualifiers="const"> diff --git a/doc/classes/EditorNode3DGizmoPlugin.xml b/doc/classes/EditorNode3DGizmoPlugin.xml index 424d5dd310..08423c4577 100644 --- a/doc/classes/EditorNode3DGizmoPlugin.xml +++ b/doc/classes/EditorNode3DGizmoPlugin.xml @@ -4,7 +4,8 @@ Used by the editor to define Node3D gizmo types. </brief_description> <description> - EditorNode3DGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending [EditorNode3DGizmoPlugin] for the simpler gizmos, or creating a new [EditorNode3DGizmo] type. See the tutorial in the documentation for more info. + [EditorNode3DGizmoPlugin] allows you to define a new type of Gizmo. There are two main ways to do so: extending [EditorNode3DGizmoPlugin] for the simpler gizmos, or creating a new [EditorNode3DGizmo] type. See the tutorial in the documentation for more info. + To use [EditorNode3DGizmoPlugin], register it using the [method EditorPlugin.add_spatial_gizmo_plugin] method first. </description> <tutorials> <link title="Spatial gizmo plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/spatial_gizmos.html</link> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 4aa6963f57..8df6d721d4 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -381,7 +381,7 @@ <argument index="0" name="importer" type="EditorImportPlugin" /> <description> Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. - [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_import_plugin] instead. + [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_format_importer_plugin] instead. See [method add_inspector_plugin] for an example of how to register a plugin. </description> </method> @@ -405,11 +405,18 @@ [/codeblocks] </description> </method> - <method name="add_scene_import_plugin"> + <method name="add_scene_format_importer_plugin"> <return type="void" /> - <argument index="0" name="scene_importer" type="EditorSceneImporter" /> + <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> <description> - Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. + Registers a new [EditorSceneFormatImporter]. Scene importers are used to import custom 3D asset formats as scenes. + </description> + </method> + <method name="add_scene_post_import_plugin"> + <return type="void" /> + <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> + <description> + Add a [EditorScenePostImportPlugin]. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs. </description> </method> <method name="add_spatial_gizmo_plugin"> @@ -462,6 +469,7 @@ <description> Gets the Editor's dialogue used for making scripts. [b]Note:[/b] Users can configure it before use. + [b]Warning:[/b] Removing and freeing this node will render a part of the editor useless and may cause a crash. </description> </method> <method name="get_undo_redo"> @@ -553,11 +561,18 @@ Removes an inspector plugin registered by [method add_import_plugin] </description> </method> - <method name="remove_scene_import_plugin"> + <method name="remove_scene_format_importer_plugin"> + <return type="void" /> + <argument index="0" name="scene_format_importer" type="EditorSceneFormatImporter" /> + <description> + Removes a scene format importer registered by [method add_scene_format_importer_plugin]. + </description> + </method> + <method name="remove_scene_post_import_plugin"> <return type="void" /> - <argument index="0" name="scene_importer" type="EditorSceneImporter" /> + <argument index="0" name="scene_import_plugin" type="EditorScenePostImportPlugin" /> <description> - Removes a scene importer registered by [method add_scene_import_plugin]. + Remove the [EditorScenePostImportPlugin], added with [method add_scene_post_import_plugin]. </description> </method> <method name="remove_spatial_gizmo_plugin"> diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneFormatImporter.xml index a400db551f..6dbd80604e 100644 --- a/doc/classes/EditorSceneImporter.xml +++ b/doc/classes/EditorSceneFormatImporter.xml @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporter" inherits="RefCounted" version="4.0"> +<class name="EditorSceneFormatImporter" inherits="RefCounted" version="4.0"> <brief_description> Imports scenes from third-parties' 3D files. </brief_description> <description> + [EditorSceneFormatImporter] allows to define an importer script for a third-party 3D format. + To use [EditorSceneFormatImporter], register it using the [method EditorPlugin.add_scene_format_importer_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/EditorSceneFormatImporterFBX.xml b/doc/classes/EditorSceneFormatImporterFBX.xml new file mode 100644 index 0000000000..117030dfd5 --- /dev/null +++ b/doc/classes/EditorSceneFormatImporterFBX.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneFormatImporterFBX" inherits="EditorSceneFormatImporter" version="4.0"> + <brief_description> + FBX 3D asset importer. + </brief_description> + <description> + This is an FBX 3D asset importer with full support for most FBX features. + If exporting a FBX scene from Autodesk Maya, use these FBX export settings: + [codeblock] + - Smoothing Groups + - Smooth Mesh + - Triangluate (for meshes with blend shapes) + - Bake Animation + - Resample All + - Deformed Models + - Skins + - Blend Shapes + - Curve Filters + - Constant Key Reducer + - Auto Tangents Only + - *Do not check* Constraints (as it will break the file) + - Can check Embed Media (embeds textures into the exported FBX file) + - Note that when importing embedded media, the texture and mesh will be a single immutable file. + - You will have to re-export then re-import the FBX if the texture has changed. + - Units: Centimeters + - Up Axis: Y + - Binary format in FBX 2017 + [/codeblock] + </description> + <tutorials> + </tutorials> +</class> diff --git a/doc/classes/EditorSceneFormatImporterGLTF.xml b/doc/classes/EditorSceneFormatImporterGLTF.xml new file mode 100644 index 0000000000..1476a22aef --- /dev/null +++ b/doc/classes/EditorSceneFormatImporterGLTF.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSceneFormatImporterGLTF" inherits="EditorSceneFormatImporter" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> +</class> diff --git a/doc/classes/EditorScenePostImportPlugin.xml b/doc/classes/EditorScenePostImportPlugin.xml new file mode 100644 index 0000000000..07d8fa28b9 --- /dev/null +++ b/doc/classes/EditorScenePostImportPlugin.xml @@ -0,0 +1,116 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorScenePostImportPlugin" inherits="RefCounted" version="4.0"> + <brief_description> + Plugin to control and modifying the process of importing a scene. + </brief_description> + <description> + This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process. + </description> + <tutorials> + </tutorials> + <methods> + <method name="_get_import_options" qualifiers="virtual"> + <return type="void" /> + <description> + Override to add general import options. These will appear in the main import dock on the editor. Add options via [method add_import_option] and [method add_import_option_advanced]. + </description> + </method> + <method name="_get_internal_import_options" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="category" type="int" /> + <description> + Override to add internal import options. These will appear in the 3D scene import dialog. Add options via [method add_import_option] and [method add_import_option_advanced]. + </description> + </method> + <method name="_get_internal_option_update_view_required" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="option" type="String" /> + <description> + Return true whether updating the 3D view of the import dialog needs to be updated if an option has changed. + </description> + </method> + <method name="_get_internal_option_visibility" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="option" type="String" /> + <description> + Return true or false whether a given option should be visible. Return null to ignore. + </description> + </method> + <method name="_get_option_visibility" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="option" type="String" /> + <description> + Return true or false whether a given option should be visible. Return null to ignore. + </description> + </method> + <method name="_internal_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="category" type="int" /> + <argument index="1" name="base_node" type="Node" /> + <argument index="2" name="node" type="Node" /> + <argument index="3" name="resource" type="Resource" /> + <description> + Process a specific node or resource for a given category. + </description> + </method> + <method name="_post_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="scene" type="Node" /> + <description> + Post process the scene. This function is called after the final scene has been configured. + </description> + </method> + <method name="_pre_process" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="scene" type="Node" /> + <description> + Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made. + </description> + </method> + <method name="add_import_option"> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="Variant" /> + <description> + Add a specific import option (name and default value only). This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. + </description> + </method> + <method name="add_import_option_advanced"> + <return type="void" /> + <argument index="0" name="type" type="int" enum="Variant.Type" /> + <argument index="1" name="name" type="String" /> + <argument index="2" name="default_value" type="Variant" /> + <argument index="3" name="hint" type="int" enum="PropertyHint" default="0" /> + <argument index="4" name="hint_string" type="String" default="""" /> + <argument index="5" name="usage_flags" type="int" default="7" /> + <description> + Add a specific import option. This function can only be called from [method _get_import_options] and [method _get_internal_import_options]. + </description> + </method> + <method name="get_option_value" qualifiers="const"> + <return type="Variant" /> + <argument index="0" name="name" type="StringName" /> + <description> + Query the value of an option. This function can only be called from those querying visibility, or processing. + </description> + </method> + </methods> + <constants> + <constant name="INTERNAL_IMPORT_CATEGORY_NODE" value="0" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MESH_3D_NODE" value="1" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MESH" value="2" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MATERIAL" value="3" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION" value="4" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_ANIMATION_NODE" value="5" enum="InternalImportCategory"> + </constant> + <constant name="INTERNAL_IMPORT_CATEGORY_MAX" value="6" enum="InternalImportCategory"> + </constant> + </constants> +</class> diff --git a/doc/classes/EditorTranslationParserPlugin.xml b/doc/classes/EditorTranslationParserPlugin.xml index de8204def3..900d877f12 100644 --- a/doc/classes/EditorTranslationParserPlugin.xml +++ b/doc/classes/EditorTranslationParserPlugin.xml @@ -4,7 +4,7 @@ Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.). </brief_description> <description> - Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method _parse_file] method in script. + [EditorTranslationParserPlugin] is invoked when a file is being parsed to extract strings that require translation. To define the parsing and string extraction logic, override the [method _parse_file] method in script. Add the extracted strings to argument [code]msgids[/code] or [code]msgids_context_plural[/code] if context or plural is used. When adding to [code]msgids_context_plural[/code], you must add the data using the format [code]["A", "B", "C"][/code], where [code]A[/code] represents the extracted string, [code]B[/code] represents the context, and [code]C[/code] represents the plural version of the extracted string. If you want to add only context but not plural, put [code]""[/code] for the plural slot. The idea is the same if you only want to add plural but not context. See the code below for concrete examples. The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu. @@ -98,6 +98,7 @@ } [/csharp] [/codeblocks] + To use [EditorTranslationParserPlugin], register it using the [method EditorPlugin.add_translation_parser_plugin] method first. </description> <tutorials> </tutorials> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 98b0de6ce1..80298a0319 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -101,8 +101,10 @@ If [code]true[/code], fog effects are enabled. </member> <member name="fog_height" type="float" setter="set_fog_height" getter="get_fog_height" default="0.0"> + The height at which the height fog effect begins. </member> <member name="fog_height_density" type="float" setter="set_fog_height_density" getter="get_fog_height_density" default="0.0"> + The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value. </member> <member name="fog_light_color" type="Color" setter="set_fog_light_color" getter="get_fog_light_color" default="Color(0.5, 0.6, 0.7, 1)"> </member> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index 22b5c72fa9..fa43f97104 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -32,12 +32,14 @@ <return type="LineEdit" /> <description> Returns the LineEdit for the selected file. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_vbox"> <return type="VBoxContainer" /> <description> Returns the vertical box container of the dialog, custom controls can be added to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="invalidate"> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 2213b9b8b2..673bf19122 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -89,8 +89,8 @@ <method name="get_zoom_hbox"> <return type="HBoxContainer" /> <description> - Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. - Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of its children, use their [member CanvasItem.visible] property instead. + Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="is_node_connected"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index e3e4a9fa7d..0a995c770b 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -165,6 +165,7 @@ <return type="VScrollBar" /> <description> Returns the [Object] ID associated with the list. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="is_anything_selected"> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 4ad71d1e80..75f2d72396 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -67,6 +67,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_opentype_feature" qualifiers="const"> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 5bdc9cccd9..dda9b98db4 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -15,6 +15,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="set_disable_shortcuts"> diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml index 507a76197a..b72ce46310 100644 --- a/doc/classes/MeshInstance3D.xml +++ b/doc/classes/MeshInstance3D.xml @@ -41,6 +41,12 @@ This helper creates a [StaticBody3D] child node with a [ConcavePolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. </description> </method> + <method name="find_blend_shape_by_name"> + <return type="int" /> + <argument index="0" name="name" type="StringName" /> + <description> + </description> + </method> <method name="get_active_material" qualifiers="const"> <return type="Material" /> <argument index="0" name="surface" type="int" /> @@ -48,6 +54,17 @@ Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material. </description> </method> + <method name="get_blend_shape_count" qualifiers="const"> + <return type="int" /> + <description> + </description> + </method> + <method name="get_blend_shape_value" qualifiers="const"> + <return type="float" /> + <argument index="0" name="blend_shape_idx" type="int" /> + <description> + </description> + </method> <method name="get_surface_override_material" qualifiers="const"> <return type="Material" /> <argument index="0" name="surface" type="int" /> @@ -61,6 +78,13 @@ Returns the number of surface override materials. This is equivalent to [method Mesh.get_surface_count]. </description> </method> + <method name="set_blend_shape_value"> + <return type="void" /> + <argument index="0" name="blend_shape_idx" type="int" /> + <argument index="1" name="value" type="float" /> + <description> + </description> + </method> <method name="set_surface_override_material"> <return type="void" /> <argument index="0" name="surface" type="int" /> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 264ef9975a..5c64dc4162 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -84,6 +84,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] contained in this button. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_selected_id" qualifiers="const"> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 78e1e81752..f7a68e6a24 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -36,17 +36,24 @@ <method name="Plane" qualifiers="constructor"> <return type="Plane" /> <argument index="0" name="normal" type="Vector3" /> + <argument index="1" name="point" type="Vector3" /> + <description> + Creates a plane from the normal vector and a point in the plane. + </description> + </method> + <method name="Plane" qualifiers="constructor"> + <return type="Plane" /> + <argument index="0" name="normal" type="Vector3" /> <argument index="1" name="d" type="float" /> <description> - Creates a plane from the normal and the plane's distance to the origin. + Creates a plane from the normal vector and the plane's distance to the origin. </description> </method> <method name="Plane" qualifiers="constructor"> <return type="Plane" /> - <argument index="0" name="point" type="Vector3" /> - <argument index="1" name="normal" type="Vector3" /> + <argument index="0" name="normal" type="Vector3" /> <description> - Creates a plane from the given position and a plane normal. + Creates a plane from the normal vector. The plane will intersect the origin. </description> </method> <method name="Plane" qualifiers="constructor"> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index a2e1c3d2c2..668f9af4a2 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -101,6 +101,7 @@ <return type="VScrollBar" /> <description> Returns the vertical scrollbar. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> <method name="get_visible_line_count" qualifiers="const"> diff --git a/doc/classes/RigidDynamicBody2D.xml b/doc/classes/RigidDynamicBody2D.xml index 9baed392eb..f503884192 100644 --- a/doc/classes/RigidDynamicBody2D.xml +++ b/doc/classes/RigidDynamicBody2D.xml @@ -174,27 +174,27 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody2D's [Shape2D]s collides with another [PhysicsBody2D] or [TileMap]'s [Shape2D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody2D's [Shape2D]s and another [PhysicsBody2D] or [TileMap]'s [Shape2D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - [code]body_shape[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. - [code]local_shape[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. + [code]body_shape_index[/code] the index of the [Shape2D] of the other [PhysicsBody2D] or [TileMap] used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape2D] of this RigidDynamicBody2D used by the [PhysicsServer2D]. Get the [CollisionShape2D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. </description> </signal> <signal name="sleeping_state_changed"> diff --git a/doc/classes/RigidDynamicBody3D.xml b/doc/classes/RigidDynamicBody3D.xml index 7d1c7fecfa..6c8d190704 100644 --- a/doc/classes/RigidDynamicBody3D.xml +++ b/doc/classes/RigidDynamicBody3D.xml @@ -177,28 +177,28 @@ <signal name="body_shape_entered"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when one of this RigidDynamicBody3D's [Shape3D]s collides with another [PhysicsBody3D] or [GridMap]'s [Shape3D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. + [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices. </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_rid" type="RID" /> <argument index="1" name="body" type="Node" /> - <argument index="2" name="body_shape" type="int" /> - <argument index="3" name="local_shape" type="int" /> + <argument index="2" name="body_shape_index" type="int" /> + <argument index="3" name="local_shape_index" type="int" /> <description> Emitted when the collision between one of this RigidDynamicBody3D's [Shape3D]s and another [PhysicsBody3D] or [GridMap]'s [Shape3D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. - [code]body_id[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. + [code]body_rid[/code] the [RID] of the other [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [GridMap]s are detected if the Meshes have [Shape3D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. - [code]body_shape[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. - [code]local_shape[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. + [code]body_shape_index[/code] the index of the [Shape3D] of the other [PhysicsBody3D] or [GridMap] used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]body.shape_owner_get_owner(body_shape_index)[/code]. + [code]local_shape_index[/code] the index of the [Shape3D] of this RigidDynamicBody3D used by the [PhysicsServer3D]. Get the [CollisionShape3D] node with [code]self.shape_owner_get_owner(local_shape_index)[/code]. [b]Note:[/b] Bullet physics cannot identify the shape index when using a [ConcavePolygonShape3D]. Don't use multiple [CollisionShape3D]s when using a [ConcavePolygonShape3D] with Bullet physics if you need shape indices. </description> </signal> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 1cf8c6cb54..976c32c243 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -22,12 +22,14 @@ <return type="HScrollBar" /> <description> Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the horizontal scrollbar, use [member scroll_horizontal_enabled]. If you want to only hide it instead, use [member scroll_horizontal_visible]. </description> </method> <method name="get_v_scrollbar"> <return type="VScrollBar" /> <description> Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to disable the vertical scrollbar, use [member scroll_vertical_enabled]. If you want to only hide it instead, use [member scroll_vertical_visible]. </description> </method> </methods> diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml index 6ab5ed55a3..e804e7bf24 100644 --- a/doc/classes/Skeleton3D.xml +++ b/doc/classes/Skeleton3D.xml @@ -47,6 +47,11 @@ Removes the local pose override on all bones in the skeleton. </description> </method> + <method name="create_skin_from_rest_transforms"> + <return type="Skin" /> + <description> + </description> + </method> <method name="execute_modifications"> <return type="void" /> <argument index="0" name="delta" type="float" /> @@ -88,13 +93,6 @@ Returns the amount of bones in the skeleton. </description> </method> - <method name="get_bone_custom_pose" qualifiers="const"> - <return type="Transform3D" /> - <argument index="0" name="bone_idx" type="int" /> - <description> - Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - </description> - </method> <method name="get_bone_global_pose" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="bone_idx" type="int" /> @@ -144,6 +142,24 @@ Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. </description> </method> + <method name="get_bone_pose_position" qualifiers="const"> + <return type="Vector3" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> + <method name="get_bone_pose_rotation" qualifiers="const"> + <return type="Quaternion" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> + <method name="get_bone_pose_scale" qualifiers="const"> + <return type="Vector3" /> + <argument index="0" name="bone_idx" type="int" /> + <description> + </description> + </method> <method name="get_bone_rest" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="bone_idx" type="int" /> @@ -196,13 +212,6 @@ Returns whether the bone pose for the bone at [code]bone_idx[/code] is enabled. </description> </method> - <method name="is_bone_rest_disabled" qualifiers="const"> - <return type="bool" /> - <argument index="0" name="bone_idx" type="int" /> - <description> - Returns whether the bone rest for the bone at [code]bone_idx[/code] is disabled. - </description> - </method> <method name="local_pose_to_global_pose"> <return type="Transform3D" /> <argument index="0" name="bone_idx" type="int" /> @@ -272,23 +281,6 @@ Sets the children for the passed in bone, [code]bone_idx[/code], to the passed-in array of bone indexes, [code]bone_children[/code]. </description> </method> - <method name="set_bone_custom_pose"> - <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="custom_pose" type="Transform3D" /> - <description> - Sets the custom pose transform, [code]custom_pose[/code], for the bone at [code]bone_idx[/code]. This pose is an addition to the bone rest pose. - [b]Note:[/b] The pose transform needs to be in bone space. Use [method world_transform_to_global_pose] to convert a world transform, like one you can get from a [Node3D], to bone space. - </description> - </method> - <method name="set_bone_disable_rest"> - <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="disable" type="bool" /> - <description> - Disables the rest pose for the bone at [code]bone_idx[/code] if [code]true[/code], enables the bone rest if [code]false[/code]. - </description> - </method> <method name="set_bone_enabled"> <return type="void" /> <argument index="0" name="bone_idx" type="int" /> @@ -337,13 +329,25 @@ [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. </description> </method> - <method name="set_bone_pose"> + <method name="set_bone_pose_position"> <return type="void" /> <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="pose" type="Transform3D" /> + <argument index="1" name="position" type="Vector3" /> + <description> + </description> + </method> + <method name="set_bone_pose_rotation"> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> + <argument index="1" name="rotation" type="Quaternion" /> + <description> + </description> + </method> + <method name="set_bone_pose_scale"> + <return type="void" /> + <argument index="0" name="bone_idx" type="int" /> + <argument index="1" name="scale" type="Vector3" /> <description> - Sets the pose transform for bone [code]bone_idx[/code]. - [b]Note:[/b] The pose transform needs to be in bone space. Use [method world_transform_to_global_pose] to convert a world transform, like one you can get from a [Node3D], to bone space. </description> </method> <method name="set_bone_rest"> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index 33d2b472b5..615f5e3586 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -39,6 +39,7 @@ <return type="LineEdit" /> <description> Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property. </description> </method> </methods> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 4c50aa4e1f..1f32bba5a1 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -20,6 +20,7 @@ <return type="Popup" /> <description> Returns the [Popup] node instance if one has been set already with [method set_popup]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_previous_tab" qualifiers="const"> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 3667dbf578..a3914b58df 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -314,6 +314,7 @@ <return type="PopupMenu" /> <description> Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. + [b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property. </description> </method> <method name="get_minimap_line_at_pos" qualifiers="const"> diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml index d12ac840f4..881a1c3d07 100644 --- a/doc/classes/TileSetAtlasSource.xml +++ b/doc/classes/TileSetAtlasSource.xml @@ -15,12 +15,6 @@ <tutorials> </tutorials> <methods> - <method name="clear_tiles_outside_texture"> - <return type="void" /> - <description> - Clears all tiles that are defined outside the texture boundaries. - </description> - </method> <method name="create_alternative_tile"> <return type="int" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -124,6 +118,16 @@ Returns a tile's texture region in the atlas texture. For animated tiles, a [code]frame[/code] argument might be provided for the different frames of the animation. </description> </method> + <method name="get_tiles_to_be_removed_on_change"> + <return type="PackedVector2Array" /> + <argument index="0" name="texture" type="Texture2D" /> + <argument index="1" name="margins" type="Vector2i" /> + <argument index="2" name="separation" type="Vector2i" /> + <argument index="3" name="texture_region_size" type="Vector2i" /> + <description> + Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: [code]texture[/code], [code]margins[/code], [code]separation[/code] or [code]texture_region_size[/code]. This can be used to undo changes that would have caused tiles data loss. + </description> + </method> <method name="has_room_for_tile" qualifiers="const"> <return type="bool" /> <argument index="0" name="atlas_coords" type="Vector2i" /> @@ -136,12 +140,6 @@ Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If [code]ignored_tile[/code] is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties. </description> </method> - <method name="has_tiles_outside_texture"> - <return type="bool" /> - <description> - Returns if this atlas has tiles outside of its texture. - </description> - </method> <method name="move_tile_in_atlas"> <return type="void" /> <argument index="0" name="atlas_coords" type="Vector2i" /> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index f94018c96b..488a5aa340 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -146,6 +146,7 @@ <description> Sets the number of times the tweening sequence will be repeated, i.e. [code]set_loops(2)[/code] will run the animation twice. Calling this method without arguments will make the [Tween] run infinitely, until it is either killed by [method kill] or by freeing bound node, or all the animated objects have been freed (which makes further animation impossible). + [b]Warning:[/b] Make sure to always add some duration/delay when using infinite loops. 0-duration looped animations (e.g. single [CallbackTweener] with no delay) are equivalent to infinite [code]while[/code] loops and will freeze your game. </description> </method> <method name="set_parallel"> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 4f60b9d567..c8590988f5 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -5,9 +5,9 @@ </brief_description> <description> Control node for playing video streams using [VideoStream] resources. - Supported video formats are [url=https://www.webmproject.org/]WebM[/url] ([code].webm[/code], [VideoStreamWebm]), [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]), and any format exposed via a GDNative plugin using [VideoStreamGDNative]. + Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDNative plugin using [VideoStreamGDNative]. [b]Note:[/b] Due to a bug, VideoPlayer does not support localization remapping yet. - [b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations, especially for VP8/VP9. + [b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations. </description> <tutorials> </tutorials> |