diff options
Diffstat (limited to 'doc')
99 files changed, 931 insertions, 575 deletions
diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index 116b54e39e..71ed82cf46 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -10,19 +10,6 @@ <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> - <methods> - <method name="get_mix_mode" qualifiers="const"> - <return type="int" enum="AnimationNodeOneShot.MixMode" /> - <description> - </description> - </method> - <method name="set_mix_mode"> - <return type="void" /> - <argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode" /> - <description> - </description> - </method> - </methods> <members> <member name="autorestart" type="bool" setter="set_autorestart" getter="has_autorestart" default="false"> If [code]true[/code], the sub-animation will restart automatically after finishing. @@ -37,6 +24,8 @@ </member> <member name="fadeout_time" type="float" setter="set_fadeout_time" getter="get_fadeout_time" default="0.1"> </member> + <member name="mix_mode" type="int" setter="set_mix_mode" getter="get_mix_mode" enum="AnimationNodeOneShot.MixMode" default="0"> + </member> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync" default="false"> </member> </members> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 0f7e6799be..5280b7445d 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -31,7 +31,7 @@ <return type="bool" /> <argument index="0" name="area" type="Node" /> <description> - If [code]true[/code], the given area overlaps the Area2D. + Returns [code]true[/code] if the given [Area2D] intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> @@ -39,9 +39,9 @@ <return type="bool" /> <argument index="0" name="body" type="Node" /> <description> - If [code]true[/code], the given physics body overlaps the Area2D. + Returns [code]true[/code] if the given physics body intersects or overlaps this [Area2D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. - The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body). + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance. While TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body. </description> </method> </methods> diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 450ed44307..4f456cb56d 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -29,7 +29,7 @@ <return type="bool" /> <argument index="0" name="area" type="Node" /> <description> - If [code]true[/code], the given area overlaps the Area3D. + Returns [code]true[/code] if the given [Area3D] intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. </description> </method> @@ -37,9 +37,9 @@ <return type="bool" /> <argument index="0" name="body" type="Node" /> <description> - If [code]true[/code], the given physics body overlaps the Area3D. + Returns [code]true[/code] if the given physics body intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. - The [code]body[/code] argument can either be a [PhysicsBody3D] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). + The [code]body[/code] argument can either be a [PhysicsBody3D] or a [GridMap] instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body. </description> </method> </methods> diff --git a/doc/classes/AudioEffectSpectrumAnalyzer.xml b/doc/classes/AudioEffectSpectrumAnalyzer.xml index b2f2c55aa2..50e38d5d1e 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzer.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzer.xml @@ -8,8 +8,8 @@ See also [AudioStreamGenerator] for procedurally generating sounds. </description> <tutorials> - <link title="https://godotengine.org/asset-library/asset/528">Audio Spectrum Demo</link> - <link title="https://godotengine.org/article/godot-32-will-get-new-audio-features">Godot 3.2 will get new audio features</link> + <link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link> + <link title="Godot 3.2 will get new audio features">https://godotengine.org/article/godot-32-will-get-new-audio-features</link> </tutorials> <members> <member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length" default="2.0"> diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index 05406846ce..e54ce27a83 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -10,7 +10,7 @@ </description> <tutorials> <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link> - <link title="https://godotengine.org/article/godot-32-will-get-new-audio-features">Godot 3.2 will get new audio features</link> + <link title="Godot 3.2 will get new audio features">https://godotengine.org/article/godot-32-will-get-new-audio-features</link> </tutorials> <members> <member name="buffer_length" type="float" setter="set_buffer_length" getter="get_buffer_length" default="0.5"> diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 7520d5d97a..42caa23763 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -8,7 +8,7 @@ </description> <tutorials> <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link> - <link title="https://godotengine.org/article/godot-32-will-get-new-audio-features">Godot 3.2 will get new audio features</link> + <link title="Godot 3.2 will get new audio features">https://godotengine.org/article/godot-32-will-get-new-audio-features</link> </tutorials> <methods> <method name="can_push_buffer" qualifiers="const"> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 1b77a5b4d8..714af426b3 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -38,7 +38,7 @@ <return type="void" /> <argument index="0" name="pressed" type="bool" /> <description> - Changes the [member pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. + Changes the [member button_pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group]. </description> </method> @@ -54,6 +54,10 @@ Binary mask to choose which mouse buttons this button will respond to. To allow both left-click and right-click, use [code]MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT[/code]. </member> + <member name="button_pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> + If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code]. + [b]Note:[/b] Setting [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal]. + </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false"> If [code]true[/code], the button is in disabled state and can't be clicked or toggled. </member> @@ -62,10 +66,6 @@ If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it. [b]Note:[/b] This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value. </member> - <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false"> - If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active). Only works if [member toggle_mode] is [code]true[/code]. - [b]Note:[/b] Setting [member pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal]. - </member> <member name="shortcut" type="Shortcut" setter="set_shortcut" getter="get_shortcut"> [Shortcut] associated to the button. </member> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index dc655ee3b0..ebcdcab75e 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -9,6 +9,12 @@ <tutorials> </tutorials> <methods> + <method name="convert_to_image" qualifiers="const"> + <return type="Image" /> + <description> + Returns an image of the same size as the bitmap and with a [enum Image.Format] of type [code]FORMAT_L8[/code]. [code]true[/code] bits of the bitmap are being converted into white pixels, and [code]false[/code] bits into black. + </description> + </method> <method name="create"> <return type="void" /> <argument index="0" name="size" type="Vector2" /> @@ -64,6 +70,13 @@ [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="resize"> + <return type="void" /> + <argument index="0" name="new_size" type="Vector2" /> + <description> + Resizes the image to [code]new_size[/code]. + </description> + </method> <method name="set_bit"> <return type="void" /> <argument index="0" name="position" type="Vector2" /> diff --git a/doc/classes/BoxMesh.xml b/doc/classes/BoxMesh.xml index af3365b6ea..bf499c8971 100644 --- a/doc/classes/BoxMesh.xml +++ b/doc/classes/BoxMesh.xml @@ -11,7 +11,7 @@ <tutorials> </tutorials> <members> - <member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(2, 2, 2)"> + <member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(1, 1, 1)"> The box's width, height and depth. </member> <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth" default="0"> diff --git a/doc/classes/BoxShape3D.xml b/doc/classes/BoxShape3D.xml index 3bfded6512..cf2bf2338b 100644 --- a/doc/classes/BoxShape3D.xml +++ b/doc/classes/BoxShape3D.xml @@ -12,7 +12,7 @@ <link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link> </tutorials> <members> - <member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(2, 2, 2)"> + <member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3(1, 1, 1)"> The box's width, height and depth. </member> </members> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index e3e781ac10..24bdc95baf 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -28,7 +28,7 @@ </members> <signals> <signal name="pressed"> - <argument index="0" name="button" type="Object" /> + <argument index="0" name="button" type="BaseButton" /> <description> Emitted when one of the buttons of the group is pressed. </description> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 44845947b1..16aa7309cc 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -334,7 +334,7 @@ <method name="get_global_mouse_position" qualifiers="const"> <return type="Vector2" /> <description> - Returns the global position of the mouse. + Returns the mouse's position in the [CanvasLayer] that this [CanvasItem] is in using the coordinate system of the [CanvasLayer]. </description> </method> <method name="get_global_transform" qualifiers="const"> @@ -352,7 +352,7 @@ <method name="get_local_mouse_position" qualifiers="const"> <return type="Vector2" /> <description> - Returns the mouse position relative to this item's position. + Returns the mouse's position in this [CanvasItem] using the local coordinate system of this [CanvasItem]. </description> </method> <method name="get_transform" qualifiers="const"> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 9ee5ce0dcb..614bd558e8 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -44,5 +44,16 @@ <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform" default="Transform2D(1, 0, 0, 1, 0, 0)"> The layer's transform. </member> + <member name="visible" type="bool" setter="set_visible" getter="is_visible" default="true"> + If [code]false[/code], any [CanvasItem] under this [CanvasLayer] will be hidden. + Unlike [member CanvasItem.visible], visibility of a [CanvasLayer] isn't propagated to underlying layers. + </member> </members> + <signals> + <signal name="visibility_changed"> + <description> + Emitted when visibility of the layer is changed. See [member visible]. + </description> + </signal> + </signals> </class> diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml index 3b4e60ce93..45dd64c174 100644 --- a/doc/classes/CapsuleMesh.xml +++ b/doc/classes/CapsuleMesh.xml @@ -9,13 +9,13 @@ <tutorials> </tutorials> <members> - <member name="height" type="float" setter="set_height" getter="get_height" default="3.0"> + <member name="height" type="float" setter="set_height" getter="get_height" default="2.0"> Total height of the capsule mesh (including the hemispherical ends). </member> <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments" default="64"> Number of radial segments on the capsule mesh. </member> - <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5"> Radius of the capsule mesh. </member> <member name="rings" type="int" setter="set_rings" getter="get_rings" default="8"> diff --git a/doc/classes/CapsuleShape3D.xml b/doc/classes/CapsuleShape3D.xml index 8856ec3779..ba4ead4930 100644 --- a/doc/classes/CapsuleShape3D.xml +++ b/doc/classes/CapsuleShape3D.xml @@ -10,10 +10,10 @@ <link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link> </tutorials> <members> - <member name="height" type="float" setter="set_height" getter="get_height" default="3.0"> + <member name="height" type="float" setter="set_height" getter="get_height" default="2.0"> The capsule's height. </member> - <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5"> The capsule's radius. </member> </members> diff --git a/doc/classes/CharacterBody2D.xml b/doc/classes/CharacterBody2D.xml index 28a9107db6..1c4475dd70 100644 --- a/doc/classes/CharacterBody2D.xml +++ b/doc/classes/CharacterBody2D.xml @@ -165,9 +165,6 @@ If [code]true[/code], the body will not slide on slopes when calling [method move_and_slide] when the body is standing still. If [code]false[/code], the body will slide on floor's slopes when [member motion_velocity] applies a downward force. </member> - <member name="free_mode_min_slide_angle" type="float" setter="set_free_mode_min_slide_angle" getter="get_free_mode_min_slide_angle" default="0.261799"> - Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. - </member> <member name="max_slides" type="int" setter="set_max_slides" getter="get_max_slides" default="4"> Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. </member> @@ -192,12 +189,15 @@ <member name="up_direction" type="Vector2" setter="set_up_direction" getter="get_up_direction" default="Vector2(0, -1)"> Direction vector used to determine what is a wall and what is a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. Defaults to [code]Vector2.UP[/code]. If set to [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. </member> + <member name="wall_min_slide_angle" type="float" setter="set_wall_min_slide_angle" getter="get_wall_min_slide_angle" default="0.261799"> + Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. This property only affects movement when [member motion_mode] is [constant MOTION_MODE_FLOATING]. + </member> </members> <constants> <constant name="MOTION_MODE_GROUNDED" value="0" enum="MotionMode"> Apply when notions of walls, ceiling and floor are relevant. In this mode the body motion will react to slopes (acceleration/slowdown). This mode is suitable for sided games like platformers. </constant> - <constant name="MOTION_MODE_FREE" value="1" enum="MotionMode"> + <constant name="MOTION_MODE_FLOATING" value="1" enum="MotionMode"> Apply when there is no notion of floor or ceiling. All collisions will be reported as [code]on_wall[/code]. In this mode, when you slide, the speed will always be constant. This mode is suitable for top-down games. </constant> <constant name="PLATFORM_VEL_ON_LEAVE_ALWAYS" value="0" enum="MovingPlatformApplyVelocityOnLeave"> diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 819190fd69..a5df0fd97e 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -175,14 +175,14 @@ Direction vector used to determine what is a wall and what is a floor (or a ceiling), rather than a wall, when calling [method move_and_slide]. Defaults to [code]Vector3.UP[/code]. If set to [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. </member> <member name="wall_min_slide_angle" type="float" setter="set_wall_min_slide_angle" getter="get_wall_min_slide_angle" default="0.261799"> - Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. In [code]MOTION_MODE_GROUNDED[/code], it works only when [member floor_block_on_wall] is [code]true[/code]. + Minimum angle (in radians) where the body is allowed to slide when it encounters a slope. The default value equals 15 degrees. When [member motion_mode] is [constant MOTION_MODE_GROUNDED], it only affects movement if [member floor_block_on_wall] is [code]true[/code]. </member> </members> <constants> <constant name="MOTION_MODE_GROUNDED" value="0" enum="MotionMode"> Apply when notions of walls, ceiling and floor are relevant. In this mode the body motion will react to slopes (acceleration/slowdown). This mode is suitable for grounded games like platformers. </constant> - <constant name="MOTION_MODE_FREE" value="1" enum="MotionMode"> + <constant name="MOTION_MODE_FLOATING" value="1" enum="MotionMode"> Apply when there is no notion of floor or ceiling. All collisions will be reported as [code]on_wall[/code]. In this mode, when you slide, the speed will always be constant. This mode is suitable for games without ground like space games. </constant> <constant name="PLATFORM_VEL_ON_LEAVE_ALWAYS" value="0" enum="MovingPlatformApplyVelocityOnLeave"> diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 289ac2cb28..09696d4d2a 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -345,7 +345,7 @@ <return type="void" /> <argument index="0" name="force" type="bool" default="false" /> <description> - Emits [signal request_code_completion], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. + Emits [signal code_completion_requested], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. </description> </method> <method name="set_code_completion_selected_index"> @@ -506,7 +506,7 @@ Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line. </description> </signal> - <signal name="request_code_completion"> + <signal name="code_completion_requested"> <description> Emitted when the user requests code completion. </description> @@ -607,6 +607,9 @@ <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the [CodeEdit]. </theme_item> + <theme_item name="font_placeholder_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.6)"> + Font color for [member TextEdit.placeholder_text]. + </theme_item> <theme_item name="font_readonly_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)"> Sets the font [Color] when [member TextEdit.editable] is disabled. </theme_item> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index d5551e1e04..b6c2dac33c 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -380,12 +380,6 @@ Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. </description> </method> - <method name="get_focus_owner" qualifiers="const"> - <return type="Control" /> - <description> - Returns the control that has the keyboard focus or [code]null[/code] if none. - </description> - </method> <method name="get_global_rect" qualifiers="const"> <return type="Rect2" /> <description> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml index fe75f029f0..99b5ef2f4f 100644 --- a/doc/classes/CurveTexture.xml +++ b/doc/classes/CurveTexture.xml @@ -14,7 +14,7 @@ </member> <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="CurveTexture.TextureMode" default="0"> </member> - <member name="width" type="int" setter="set_width" getter="get_width" default="2048"> + <member name="width" type="int" setter="set_width" getter="get_width" default="256"> The width of the texture. </member> </members> diff --git a/doc/classes/CurveXYZTexture.xml b/doc/classes/CurveXYZTexture.xml index 815653e987..b6dd90c7d3 100644 --- a/doc/classes/CurveXYZTexture.xml +++ b/doc/classes/CurveXYZTexture.xml @@ -13,7 +13,7 @@ </member> <member name="curve_z" type="Curve" setter="set_curve_z" getter="get_curve_z"> </member> - <member name="width" type="int" setter="set_width" getter="get_width" default="2048"> + <member name="width" type="int" setter="set_width" getter="get_width" default="256"> </member> </members> </class> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml index 077435990b..ce34cc91ad 100644 --- a/doc/classes/CylinderMesh.xml +++ b/doc/classes/CylinderMesh.xml @@ -9,7 +9,7 @@ <tutorials> </tutorials> <members> - <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" default="1.0"> + <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius" default="0.5"> Bottom radius of the cylinder. If set to [code]0.0[/code], the bottom faces will not be generated, resulting in a conic shape. </member> <member name="height" type="float" setter="set_height" getter="get_height" default="2.0"> @@ -21,7 +21,7 @@ <member name="rings" type="int" setter="set_rings" getter="get_rings" default="4"> Number of edge rings along the height of the cylinder. Changing [member rings] does not have any visual impact unless a shader or procedural mesh tool is used to alter the vertex data. Higher values result in more subdivisions, which can be used to create smoother-looking effects with shaders or procedural mesh tools (at the cost of performance). When not altering the vertex data using a shader or procedural mesh tool, [member rings] should be kept to its default value. </member> - <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius" default="1.0"> + <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius" default="0.5"> Top radius of the cylinder. If set to [code]0.0[/code], the top faces will not be generated, resulting in a conic shape. </member> </members> diff --git a/doc/classes/CylinderShape3D.xml b/doc/classes/CylinderShape3D.xml index d40b96710b..6fa6c4d75e 100644 --- a/doc/classes/CylinderShape3D.xml +++ b/doc/classes/CylinderShape3D.xml @@ -15,7 +15,7 @@ <member name="height" type="float" setter="set_height" getter="get_height" default="2.0"> The cylinder's height. </member> - <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0"> + <member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5"> The cylinder's radius. </member> </members> diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 6e06bf454c..281c218d0d 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -399,6 +399,14 @@ <description> </description> </method> + <method name="screen_get_refresh_rate" qualifiers="const"> + <return type="float" /> + <argument index="0" name="screen" type="int" default="-1" /> + <description> + Returns the current refresh rate of the specified screen. If [code]screen[/code] is [code]SCREEN_OF_MAIN_WINDOW[/code] (the default value), a screen with the main window will be used. + [b]Note:[/b] Returns [code]60.0[/code] if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, [method screen_get_refresh_rate] will always return [code]60.0[/code] as there is no way to retrieve the refresh rate on that platform. + </description> + </method> <method name="screen_get_scale" qualifiers="const"> <return type="float" /> <argument index="0" name="screen" type="int" default="-1" /> @@ -569,6 +577,15 @@ Returns the mode of the given window. </description> </method> + <method name="window_get_native_handle" qualifiers="const"> + <return type="int" /> + <argument index="0" name="handle_type" type="int" enum="DisplayServer.HandleType" /> + <argument index="1" name="window_id" type="int" default="0" /> + <description> + Returns internal structure pointers for use in plugins. + [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. + </description> + </method> <method name="window_get_position" qualifiers="const"> <return type="Vector2i" /> <argument index="0" name="window_id" type="int" default="0" /> @@ -891,6 +908,11 @@ Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project. Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. </constant> + <constant name="WINDOW_MODE_EXCLUSIVE_FULLSCREEN" value="4" enum="WindowMode"> + Exclusive fullscreen window mode. This mode is implemented on Windows only. On other platforms, it is equivalent to [constant WINDOW_MODE_FULLSCREEN]. + Only one window in exclusive fullscreen mode can be visible on a given screen at a time. If multiple windows are in exclusive fullscreen mode for the same screen, the last one being set to this mode takes precedence. + Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. + </constant> <constant name="WINDOW_FLAG_RESIZE_DISABLED" value="0" enum="WindowFlags"> </constant> <constant name="WINDOW_FLAG_BORDERLESS" value="1" enum="WindowFlags"> @@ -930,5 +952,22 @@ Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag. </constant> + <constant name="DISPLAY_HANDLE" value="0" enum="HandleType"> + Display handle: + - Linux: [code]X11::Display*[/code] for the display. + </constant> + <constant name="WINDOW_HANDLE" value="1" enum="HandleType"> + Window handle: + - Windows: [code]HWND[/code] for the window. + - Linux: [code]X11::Window*[/code] for the window. + - MacOS: [code]NSWindow*[/code] for the window. + - iOS: [code]UIViewController*[/code] for the view controller. + - Android: [code]jObject[/code] for the activity. + </constant> + <constant name="WINDOW_VIEW" value="2" enum="HandleType"> + Window view: + - MacOS: [code]NSView*[/code] for the window main view. + - iOS: [code]UIView*[/code] for the window main view. + </constant> </constants> </class> diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index 27dab3d422..de122cb8bb 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -59,8 +59,8 @@ </description> </signal> <signal name="resource_selected"> - <argument index="0" name="res" type="Object" /> - <argument index="1" name="prop" type="String" /> + <argument index="0" name="resource" type="Resource" /> + <argument index="1" name="path" type="String" /> <description> Emitted when a resource is selected in the inspector. </description> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 7b0a300782..cc1243898f 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -438,9 +438,9 @@ <method name="add_tool_submenu_item"> <return type="void" /> <argument index="0" name="name" type="String" /> - <argument index="1" name="submenu" type="Object" /> + <argument index="1" name="submenu" type="PopupMenu" /> <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. + Adds a custom [PopupMenu] submenu under [b]Project > Tools >[/b] [code]name[/code]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. </description> </method> <method name="add_translation_parser_plugin"> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index b31162f10f..c8c0494378 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -154,6 +154,13 @@ <member name="glow_levels/7" type="float" setter="set_glow_level" getter="get_glow_level" default="0.0"> The intensity of the 7th level of glow. This is the most "global" level (blurriest). </member> + <member name="glow_map" type="Texture" setter="set_glow_map" getter="get_glow_map"> + The texture that should be used as a glow map to [i]multiply[/i] the resulting glow color according to [member glow_map_strength]. This can be used to create a "lens dirt" effect. The texture's RGB color channels are used for modulation, but the alpha channel is ignored. + [b]Note:[/b] The texture will be stretched to fit the screen. Therefore, it's recommended to use a texture with an aspect ratio that matches your project's base aspect ratio (typically 16:9). + </member> + <member name="glow_map_strength" type="float" setter="set_glow_map_strength" getter="get_glow_map_strength" default="0.8"> + How strong of an impact the [member glow_map] should have on the overall glow effect. A strength of [code]0.0[/code] means the glow map has no effect on the overall glow effect. A strength of [code]1.0[/code] means the glow has a full effect on the overall glow effect (and can turn off glow entirely in specific areas of the screen if the glow map has black areas). + </member> <member name="glow_mix" type="float" setter="set_glow_mix" getter="get_glow_mix" default="0.05"> </member> <member name="glow_normalized" type="bool" setter="set_glow_normalized" getter="is_glow_normalized" default="false"> diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index 72adc49742..f97198658e 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -18,6 +18,17 @@ Returns a rectangle containing the positions of all existing particles. </description> </method> + <method name="emit_particle"> + <return type="void" /> + <argument index="0" name="xform" type="Transform2D" /> + <argument index="1" name="velocity" type="Vector2" /> + <argument index="2" name="color" type="Color" /> + <argument index="3" name="custom" type="Color" /> + <argument index="4" name="flags" type="int" /> + <description> + Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. + </description> + </method> <method name="restart"> <return type="void" /> <description> @@ -67,6 +78,9 @@ <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0"> Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. </member> + <member name="sub_emitter" type="NodePath" setter="set_sub_emitter" getter="get_sub_emitter" default="NodePath("")"> + The [NodePath] to the [GPUParticles2D] used for sub-emissions. + </member> <member name="texture" type="Texture2D" setter="set_texture" getter="get_texture"> Particle texture. If [code]null[/code], particles will be squares. </member> @@ -92,5 +106,20 @@ </constant> <constant name="DRAW_ORDER_REVERSE_LIFETIME" value="2" enum="DrawOrder"> </constant> + <constant name="EMIT_FLAG_POSITION" value="1" enum="EmitFlags"> + Particle starts at the specified position. + </constant> + <constant name="EMIT_FLAG_ROTATION_SCALE" value="2" enum="EmitFlags"> + Particle starts with specified rotation and scale. + </constant> + <constant name="EMIT_FLAG_VELOCITY" value="4" enum="EmitFlags"> + Particle starts with the specified velocity vector, which defines the emission direction and speed. + </constant> + <constant name="EMIT_FLAG_COLOR" value="8" enum="EmitFlags"> + Particle starts with specified color. + </constant> + <constant name="EMIT_FLAG_CUSTOM" value="16" enum="EmitFlags"> + Particle starts with specificed [code]CUSTOM[/code] data. + </constant> </constants> </class> diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index 771056cb93..62ac846077 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -26,6 +26,7 @@ <argument index="3" name="custom" type="Color" /> <argument index="4" name="flags" type="int" /> <description> + Emits a single particle. Whether [code]xform[/code], [code]velocity[/code], [code]color[/code] and [code]custom[/code] are applied depends on the value of [code]flags[/code]. See [enum EmitFlags]. </description> </method> <method name="get_draw_pass_mesh" qualifiers="const"> @@ -137,14 +138,19 @@ Particles are drawn in order of depth. </constant> <constant name="EMIT_FLAG_POSITION" value="1" enum="EmitFlags"> + Particle starts at the specified position. </constant> <constant name="EMIT_FLAG_ROTATION_SCALE" value="2" enum="EmitFlags"> + Particle starts with specified rotation and scale. </constant> <constant name="EMIT_FLAG_VELOCITY" value="4" enum="EmitFlags"> + Particle starts with the specified velocity vector, which defines the emission direction and speed. </constant> <constant name="EMIT_FLAG_COLOR" value="8" enum="EmitFlags"> + Particle starts with specified color. </constant> <constant name="EMIT_FLAG_CUSTOM" value="16" enum="EmitFlags"> + Particle starts with specificed [code]CUSTOM[/code] data. </constant> <constant name="MAX_DRAW_PASSES" value="4"> Maximum number of draw passes supported. diff --git a/doc/classes/GradientTexture1D.xml b/doc/classes/GradientTexture1D.xml index 223439956c..4730410ea9 100644 --- a/doc/classes/GradientTexture1D.xml +++ b/doc/classes/GradientTexture1D.xml @@ -15,7 +15,7 @@ <member name="use_hdr" type="bool" setter="set_use_hdr" getter="is_using_hdr" default="false"> If [code]true[/code], the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is [code]true[/code]. If [code]false[/code], the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). </member> - <member name="width" type="int" setter="set_width" getter="get_width" default="2048"> + <member name="width" type="int" setter="set_width" getter="get_width" default="256"> The number of color samples that will be obtained from the [Gradient]. </member> </members> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 60d4b664d2..2f4a0079c9 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -88,6 +88,15 @@ <description> </description> </method> + <method name="compute_image_metrics"> + <return type="Dictionary" /> + <argument index="0" name="compared_image" type="Image" /> + <argument index="1" name="use_luma" type="bool" /> + <description> + Compute image metrics on the current image and the compared image. + The dictionary contains [code]max[/code], [code]mean[/code], [code]mean_squared[/code], [code]root_mean_squared[/code] and [code]peak_snr[/code]. + </description> + </method> <method name="convert"> <return type="void" /> <argument index="0" name="format" type="int" enum="Image.Format" /> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 45b15331d2..b5468755c1 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -141,10 +141,10 @@ Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. </description> </method> - <method name="get_last_mouse_velocity" qualifiers="const"> + <method name="get_last_mouse_velocity"> <return type="Vector2" /> <description> - Returns the mouse velocity for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. + Returns the last mouse velocity. To provide a precise and jitter-free velocity, mouse velocity is only calculated every 0.1s. Therefore, mouse velocity will lag mouse movements. </description> </method> <method name="get_magnetometer" qualifiers="const"> @@ -209,6 +209,12 @@ [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. </description> </method> + <method name="is_anything_pressed" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if any action, key, joypad button, or mouse button is being pressed. This will also return [code]true[/code] if any action is simulated via code by calling [method action_press]. + </description> + </method> <method name="is_joy_button_pressed" qualifiers="const"> <return type="bool" /> <argument index="0" name="device" type="int" /> @@ -377,7 +383,8 @@ <return type="void" /> <argument index="0" name="to" type="Vector2" /> <description> - Sets the mouse position to the specified vector. + Sets the mouse position to the specified vector, provided in pixels and relative to an origin at the upper left corner of the game window. + Mouse position is clipped to the limits of the screen resolution, or to the limits of the game window if [enum MouseMode] is set to [code]MOUSE_MODE_CONFINED[/code] or [code]MOUSE_MODE_CONFINED_HIDDEN[/code]. </description> </method> </methods> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 5215c29b4a..054b3dbb33 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -14,10 +14,12 @@ The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks. </member> <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position" default="Vector2(0, 0)"> - The global mouse position relative to the current [Viewport]. If used in [method Control._gui_input] and if the current [Control] is not under the mouse, moving it will not update this value. + When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the root [Viewport] using the coordinate system of the root [Viewport]. + When received in [method Control._gui_input], returns the mouse's position in the [CanvasLayer] that the [Control] is in using the coordinate system of the [CanvasLayer]. </member> <member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2(0, 0)"> - The local mouse position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] which is under the mouse. If the current [Control] is not under the mouse, moving it will not update this value. + When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the [Viewport] this [Node] is in using the coordinate system of this [Viewport]. + When received in [method Control._gui_input], returns the mouse's position in the [Control] using the local coordinate system of the [Control]. </member> </members> </class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 224579e8c5..0b97865770 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -233,9 +233,6 @@ [b]Note:[/b] This method is only implemented on Linux. </member> <member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" overrides="Control" enum="Control.CursorShape" default="1" /> - <member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha" default="0.6"> - Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code]. - </member> <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder" default=""""> Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]). </member> @@ -397,6 +394,9 @@ <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the [LineEdit]. </theme_item> + <theme_item name="font_placeholder_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.6)"> + Font color for [member placeholder_text]. + </theme_item> <theme_item name="font_selected_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> Font color for selected text (inside the selection rectangle). </theme_item> diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index e0da08f5bd..642e000efc 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -79,10 +79,8 @@ <member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" default="false"> If [code]true[/code], the MultiplayerAPI's [member multiplayer_peer] refuses new incoming connections. </member> - <member name="replicator" type="MultiplayerReplicator" setter="" getter="get_replicator"> - </member> - <member name="root_node" type="Node" setter="set_root_node" getter="get_root_node"> - The root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. + <member name="root_path" type="NodePath" setter="set_root_path" getter="get_root_path" default="NodePath("")"> + The root path to use for RPCs and replication. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene. </member> </members> diff --git a/doc/classes/MultiplayerReplicator.xml b/doc/classes/MultiplayerReplicator.xml deleted file mode 100644 index c2e93ddeab..0000000000 --- a/doc/classes/MultiplayerReplicator.xml +++ /dev/null @@ -1,191 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="MultiplayerReplicator" inherits="Object" version="4.0"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <methods> - <method name="decode_state"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="data" type="PackedByteArray" /> - <argument index="3" name="initial" type="bool" default="true" /> - <description> - Decode the given [code]data[/code] representing a spawnable state into [code]object[/code] using the configuration associated with the provided [code]scene_id[/code]. This function is called automatically when a client receives a server spawn for a scene with [constant REPLICATION_MODE_SERVER]. See [method spawn_config]. - Tip: You may find this function useful in servers when parsing spawn requests from clients, or when implementing your own logic with [constant REPLICATION_MODE_CUSTOM]. - </description> - </method> - <method name="despawn"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="peer_id" type="int" default="0" /> - <description> - Request a despawn for the scene identified by [code]scene_id[/code] to the given [code]peer_id[/code]. This will either trigger the default behavior, or invoke the custom spawn/despawn callables specified in [method spawn_config]. See [method send_despawn] for the default behavior. - </description> - </method> - <method name="encode_state"> - <return type="PackedByteArray" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="initial" type="bool" default="true" /> - <description> - Encode the given [code]object[/code] using the configuration associated with the provided [code]scene_id[/code]. This function is called automatically when the server spawns scenes with [constant REPLICATION_MODE_SERVER]. See [method spawn_config]. - Tip: You may find this function useful when requesting spawns from clients to server, or when implementing your own logic with [constant REPLICATION_MODE_CUSTOM]. - </description> - </method> - <method name="send_despawn"> - <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="scene_id" type="int" /> - <argument index="2" name="data" type="Variant" default="null" /> - <argument index="3" name="path" type="NodePath" default="NodePath("")" /> - <description> - Sends a despawn request for the scene identified by [code]scene_id[/code] to the given [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). If the scene is configured as [constant REPLICATION_MODE_SERVER] (see [method spawn_config]) and the request is sent by the server (see [method MultiplayerAPI.is_server]), the receiving peer(s) will automatically queue for deletion the node at [code]path[/code] and emit the signal [signal despawned]. In all other cases no deletion happens, and the signal [signal despawn_requested] is emitted instead. - </description> - </method> - <method name="send_spawn"> - <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="scene_id" type="int" /> - <argument index="2" name="data" type="Variant" default="null" /> - <argument index="3" name="path" type="NodePath" default="NodePath("")" /> - <description> - Sends a spawn request for the scene identified by [code]scene_id[/code] to the given [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). If the scene is configured as [constant REPLICATION_MODE_SERVER] (see [method spawn_config]) and the request is sent by the server (see [method MultiplayerAPI.is_server]), the receiving peer(s) will automatically instantiate that scene, add it to the [SceneTree] at the given [code]path[/code] and emit the signal [signal spawned]. In all other cases no instantiation happens, and the signal [signal spawn_requested] is emitted instead. - </description> - </method> - <method name="send_sync"> - <return type="int" enum="Error" /> - <argument index="0" name="peer_id" type="int" /> - <argument index="1" name="scene_id" type="int" /> - <argument index="2" name="data" type="PackedByteArray" /> - <argument index="3" name="transfer_mode" type="int" enum="TransferMode" default="2" /> - <argument index="4" name="channel" type="int" default="0" /> - <description> - Sends a sync request for the instances of the scene identified by [code]scene_id[/code] to the given [code]peer_id[/code] (see [method MultiplayerPeer.set_target_peer]). This function can only be called manually when overriding the send and receive sync functions (see [method sync_config]). - </description> - </method> - <method name="spawn"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <argument index="2" name="peer_id" type="int" default="0" /> - <description> - Request a spawn for the scene identified by [code]scene_id[/code] to the given [code]peer_id[/code]. This will either trigger the default behavior, or invoke the custom spawn/despawn callables specified in [method spawn_config]. See [method send_spawn] for the default behavior. - </description> - </method> - <method name="spawn_config"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="spawn_mode" type="int" enum="MultiplayerReplicator.ReplicationMode" /> - <argument index="2" name="properties" type="StringName[]" default="[]" /> - <argument index="3" name="custom_send" type="Callable" /> - <argument index="4" name="custom_receive" type="Callable" /> - <description> - Configures the MultiplayerReplicator to track instances of the [PackedScene] identified by [code]scene_id[/code] (see [method ResourceLoader.get_resource_uid]) for the purpose of network replication. When [code]mode[/code] is [constant REPLICATION_MODE_SERVER], the specified [code]properties[/code] will also be replicated to clients during the initial spawn. You can optionally specify a [code]custom_send[/code] and a [code]custom_receive[/code] to override the default behavior and customize the spawn/despawn proecess. - Tip: You can use a custom property in the scene main script to return a customly optimized state representation. - </description> - </method> - <method name="sync_all"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="peer_id" type="int" default="0" /> - <description> - Manually request a sync for all the instances of the scene identified by [code]scene_id[/code]. This function will trigger the default sync behavior, or call your send custom send callable if specified in [method sync_config]. - [b]Note:[/b] The default implementation only allow syncing from server to clients. - </description> - </method> - <method name="sync_config"> - <return type="int" enum="Error" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="interval" type="int" /> - <argument index="2" name="properties" type="StringName[]" default="[]" /> - <argument index="3" name="custom_send" type="Callable" /> - <argument index="4" name="custom_receive" type="Callable" /> - <description> - Configures the MultiplayerReplicator to sync instances of the [PackedScene] identified by [code]scene_id[/code] (see [method ResourceLoader.get_resource_uid]) for the purpose of network replication at the desired [code]interval[/code] (in milliseconds). The specified [code]properties[/code] will be part of the state sync. You can optionally specify a [code]custom_send[/code] and a [code]custom_receive[/code] to override the default behavior and customize the synchronization proecess. - Tip: You can use a custom property in the scene main script to return a customly optimized state representation (having a single property that returns a PackedByteArray is highly recommended when dealing with many instances). - </description> - </method> - <method name="track"> - <return type="void" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <description> - Track the given [code]object[/code] as an instance of the scene identified by [code]scene_id[/code]. This object will be passed to your custom sync callables (see [method sync_config]). Tracking and untracking is automatic in [constant REPLICATION_MODE_SERVER]. - </description> - </method> - <method name="untrack"> - <return type="void" /> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="object" type="Object" /> - <description> - Untrack the given [code]object[/code]. This object will no longer be passed to your custom sync callables (see [method sync_config]). Tracking and untracking is automatic in [constant REPLICATION_MODE_SERVER]. - </description> - </method> - </methods> - <signals> - <signal name="despawn_requested"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="scene_id" type="int" /> - <argument index="2" name="parent" type="Node" /> - <argument index="3" name="name" type="String" /> - <argument index="4" name="data" type="PackedByteArray" /> - <description> - Emitted when a network despawn request has been received from a client, or for a [PackedScene] that has been configured as [constant REPLICATION_MODE_CUSTOM]. - </description> - </signal> - <signal name="despawned"> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="node" type="Node" /> - <description> - Emitted on a client before deleting a local Node upon receiving a despawn request from the server. - </description> - </signal> - <signal name="replicated_instance_added"> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="node" type="Node" /> - <description> - Emitted when an instance of a [PackedScene] that has been configured for networking enters the [SceneTree]. See [method spawn_config]. - </description> - </signal> - <signal name="replicated_instance_removed"> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="node" type="Node" /> - <description> - Emitted when an instance of a [PackedScene] that has been configured for networking leaves the [SceneTree]. See [method spawn_config]. - </description> - </signal> - <signal name="spawn_requested"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="scene_id" type="int" /> - <argument index="2" name="parent" type="Node" /> - <argument index="3" name="name" type="String" /> - <argument index="4" name="data" type="PackedByteArray" /> - <description> - Emitted when a network spawn request has been received from a client, or for a [PackedScene] that has been configured as [constant REPLICATION_MODE_CUSTOM]. - </description> - </signal> - <signal name="spawned"> - <argument index="0" name="scene_id" type="int" /> - <argument index="1" name="node" type="Node" /> - <description> - Emitted on a client after a new Node is instantiated locally and added to the SceneTree upon receiving a spawn request from the server. - </description> - </signal> - </signals> - <constants> - <constant name="REPLICATION_MODE_NONE" value="0" enum="ReplicationMode"> - Used with [method spawn_config] to identify a [PackedScene] that should not be replicated. - </constant> - <constant name="REPLICATION_MODE_SERVER" value="1" enum="ReplicationMode"> - Used with [method spawn_config] to identify a [PackedScene] that should be automatically replicated from server to clients. - </constant> - <constant name="REPLICATION_MODE_CUSTOM" value="2" enum="ReplicationMode"> - Used with [method spawn_config] to identify a [PackedScene] that can be manually replicated among peers. - </constant> - </constants> -</class> diff --git a/doc/classes/MultiplayerSpawner.xml b/doc/classes/MultiplayerSpawner.xml new file mode 100644 index 0000000000..8bfecfce41 --- /dev/null +++ b/doc/classes/MultiplayerSpawner.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiplayerSpawner" inherits="Node" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="_spawn_custom" qualifiers="virtual"> + <return type="Object" /> + <argument index="0" name="data" type="Variant" /> + <description> + </description> + </method> + <method name="spawn"> + <return type="Node" /> + <argument index="0" name="data" type="Variant" default="null" /> + <description> + </description> + </method> + </methods> + <members> + <member name="auto_spawn" type="bool" setter="set_auto_spawning" getter="is_auto_spawning" default="false"> + </member> + <member name="replication" type="PackedScene[]" setter="set_spawnable_scenes" getter="get_spawnable_scenes" default="[]"> + </member> + <member name="spawn_limit" type="int" setter="set_spawn_limit" getter="get_spawn_limit" default="0"> + </member> + <member name="spawn_path" type="NodePath" setter="set_spawn_path" getter="get_spawn_path" default="NodePath("")"> + </member> + </members> + <signals> + <signal name="despawned"> + <argument index="0" name="scene_id" type="int" /> + <argument index="1" name="node" type="Node" /> + <description> + </description> + </signal> + <signal name="spawned"> + <argument index="0" name="scene_id" type="int" /> + <argument index="1" name="node" type="Node" /> + <description> + </description> + </signal> + </signals> +</class> diff --git a/doc/classes/MultiplayerSynchronizer.xml b/doc/classes/MultiplayerSynchronizer.xml new file mode 100644 index 0000000000..242d4589a4 --- /dev/null +++ b/doc/classes/MultiplayerSynchronizer.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiplayerSynchronizer" inherits="Node" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="replication_interval" type="float" setter="set_replication_interval" getter="get_replication_interval" default="0.0"> + </member> + <member name="resource" type="SceneReplicationConfig" setter="set_replication_config" getter="get_replication_config"> + </member> + <member name="root_path" type="NodePath" setter="set_root_path" getter="get_root_path" default="NodePath("")"> + </member> + </members> +</class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index d714fbc0d5..89bc905e69 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -52,7 +52,7 @@ It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called. For gameplay input, [method _unhandled_input] and [method _unhandled_key_input] are usually a better fit as they allow the GUI to intercept the events first. - [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan). + [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). </description> </method> <method name="_physics_process" qualifiers="virtual"> @@ -62,7 +62,7 @@ Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. [code]delta[/code] is in seconds. It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. Corresponds to the [constant NOTIFICATION_PHYSICS_PROCESS] notification in [method Object._notification]. - [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan). + [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). </description> </method> <method name="_process" qualifiers="virtual"> @@ -72,38 +72,38 @@ Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. [code]delta[/code] is in seconds. It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. Corresponds to the [constant NOTIFICATION_PROCESS] notification in [method Object._notification]. - [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan). + [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). </description> </method> <method name="_ready" qualifiers="virtual"> <return type="void" /> <description> Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards. - Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]onready[/code] keyword for variables. + Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]@onready[/code] annotation for variables. Usually used for initialization. For even earlier initialization, [method Object._init] may be used. See also [method _enter_tree]. - [b]Note:[/b] [method _ready] may be called only once for each node. After removing a node from the scene tree and adding again, [code]_ready[/code] will not be called for the second time. This can be bypassed with requesting another call with [method request_ready], which may be called anywhere before adding the node again. + [b]Note:[/b] [method _ready] may be called only once for each node. After removing a node from the scene tree and adding it again, [code]_ready[/code] will not be called a second time. This can be bypassed by requesting another call with [method request_ready], which may be called anywhere before adding the node again. </description> </method> <method name="_unhandled_input" qualifiers="virtual"> <return type="void" /> <argument index="0" name="event" type="InputEvent" /> <description> - Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it. + Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called. For gameplay input, this and [method _unhandled_key_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first. - [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan). + [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> <return type="void" /> <argument index="0" name="event" type="InputEvent" /> <description> - Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it. + Called when an [InputEventKey] or [InputEventShortcut] hasn't been consumed by [method _input] or any GUI [Control] item. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input]. To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called. For gameplay input, this and [method _unhandled_input] are usually a better fit than [method _input] as they allow the GUI to intercept the events first. - [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan). + [b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan). </description> </method> <method name="add_child"> @@ -726,6 +726,18 @@ </member> </members> <signals> + <signal name="child_entered_tree"> + <argument index="0" name="node" type="Node" /> + <description> + Emitted when a child node enters the scene tree, either because it entered on its own or because this node entered with it. + </description> + </signal> + <signal name="child_exited_tree"> + <argument index="0" name="node" type="Node" /> + <description> + Emitted when a child node exits the scene tree, either because it exited on its own or because this node exited. + </description> + </signal> <signal name="ready"> <description> Emitted when the node is ready. Comes after [method _ready] callback and follows the same rules. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 1c44967aba..c752291588 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -54,7 +54,7 @@ <argument index="2" name="open_console" type="bool" default="false" /> <description> Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. - On Windows, if [code]open_console[/code] is [code]true[/code] and process is console app, new terminal window will be opened, it's ignored on other platforms. + On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. For example, running another instance of the project: [codeblocks] @@ -114,7 +114,7 @@ <argument index="4" name="open_console" type="bool" default="false" /> <description> Executes a command. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If an [code]output[/code] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [code]output[/code]. If [code]read_stderr[/code] is [code]true[/code], the output to the standard error stream will be included too. - On Windows, if [code]open_console[/code] is [code]true[/code] and process is console app, new terminal window will be opened, it's ignored on other platforms. + On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms. If the command is successfully executed, the method will return the exit code of the command, or [code]-1[/code] if it fails. [b]Note:[/b] The Godot thread will pause its execution until the executed command terminates. Use [Thread] to create a separate thread that will not pause the Godot thread, or use [method create_process] to create a completely independent process. For example, to retrieve a list of the working directory's contents: @@ -128,7 +128,7 @@ int exitCode = OS.Execute("ls", new string[] {"-l", "/tmp"}, output); [/csharp] [/codeblocks] - If you wish to access a shell built-in or perform a composite command, a platform-specific shell can be invoked. For example: + If you wish to access a shell built-in or execute a composite command, a platform-specific shell can be invoked. For example: [codeblocks] [gdscript] var output = [] diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index f5f6ba8b6d..bdc3a09322 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -490,7 +490,7 @@ <argument index="0" name="property" type="String" /> <argument index="1" name="value" type="Variant" /> <description> - Assigns a new value to the given property. If the [code]property[/code] does not exist, nothing will happen. + Assigns a new value to the given property. If the [code]property[/code] does not exist or the given value's type doesn't match, nothing will happen. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). </description> </method> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 7bb67be4c4..02226df46b 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -84,7 +84,7 @@ <method name="get_selected_id" qualifiers="const"> <return type="int" /> <description> - Returns the ID of the selected item, or [code]0[/code] if no item is selected. + Returns the ID of the selected item, or [code]-1[/code] if no item is selected. </description> </method> <method name="get_selected_metadata" qualifiers="const"> @@ -112,6 +112,7 @@ <argument index="0" name="idx" type="int" /> <description> Selects an item by index and makes it the current item. This will work even if the item is disabled. + Passing [code]-1[/code] as the index deselects any currently selected item. </description> </method> <method name="set_item_disabled"> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index 43e27ea437..68f7b94551 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -25,12 +25,12 @@ </method> <method name="move_and_collide"> <return type="KinematicCollision2D" /> - <argument index="0" name="linear_velocity" type="Vector2" /> + <argument index="0" name="distance" type="Vector2" /> <argument index="1" name="test_only" type="bool" default="false" /> <argument index="2" name="safe_margin" type="float" default="0.08" /> <description> - Moves the body along the vector [code]linear_velocity[/code]. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision when stopped, or when touching another body along the motion. + Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. + Returns a [KinematicCollision2D], which contains information about the collision when stopped, or when touching another body along the motion. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody2D.collision/safe_margin] for more details). </description> @@ -45,12 +45,12 @@ <method name="test_move"> <return type="bool" /> <argument index="0" name="from" type="Transform2D" /> - <argument index="1" name="linear_velocity" type="Vector2" /> + <argument index="1" name="distance" type="Vector2" /> <argument index="2" name="collision" type="KinematicCollision2D" default="null" /> <argument index="3" name="safe_margin" type="float" default="0.08" /> <description> - Checks for collisions without moving the body. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. + Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. + Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. [code]collision[/code] is an optional object of type [KinematicCollision2D], which contains additional information about the collision when stopped, or when touching another body along the motion. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody2D.collision/safe_margin] for more details). </description> diff --git a/doc/classes/PhysicsBody3D.xml b/doc/classes/PhysicsBody3D.xml index 3c52850eec..4ea93d9f54 100644 --- a/doc/classes/PhysicsBody3D.xml +++ b/doc/classes/PhysicsBody3D.xml @@ -32,12 +32,12 @@ </method> <method name="move_and_collide"> <return type="KinematicCollision3D" /> - <argument index="0" name="linear_velocity" type="Vector3" /> + <argument index="0" name="distance" type="Vector3" /> <argument index="1" name="test_only" type="bool" default="false" /> <argument index="2" name="safe_margin" type="float" default="0.001" /> <argument index="3" name="max_collisions" type="int" default="1" /> <description> - Moves the body along the vector [code]linear_velocity[/code]. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. + Moves the body along the vector [code]distance[/code]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details). @@ -62,13 +62,13 @@ <method name="test_move"> <return type="bool" /> <argument index="0" name="from" type="Transform3D" /> - <argument index="1" name="linear_velocity" type="Vector3" /> + <argument index="1" name="distance" type="Vector3" /> <argument index="2" name="collision" type="KinematicCollision3D" default="null" /> <argument index="3" name="safe_margin" type="float" default="0.001" /> <argument index="4" name="max_collisions" type="int" default="1" /> <description> - Checks for collisions without moving the body. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. - Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]linear_velocity[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. + Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [code]distance[/code] should be computed using [code]delta[/code]. + Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [code]distance[/code]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path. [code]collision[/code] is an optional object of type [KinematicCollision3D], which contains additional information about the collision when stopped, or when touching another body along the motion. [code]safe_margin[/code] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details). [code]max_collisions[/code] allows to retrieve more than one collision result. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 108c674ef7..eb1b0aada7 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -331,6 +331,13 @@ [b]Note:[/b] The indices of items after the removed item will be shifted by one. </description> </method> + <method name="set_current_index"> + <return type="void" /> + <argument index="0" name="index" type="int" /> + <description> + Sets the currently focused item as the given [code]index[/code]. + </description> + </method> <method name="set_item_accelerator"> <return type="void" /> <argument index="0" name="index" type="int" /> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index a92afb7ea7..ed124d1d15 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -356,6 +356,8 @@ <member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables warnings when a ternary operator may emit values with incompatible types. </member> + <member name="debug/gdscript/warnings/int_assigned_to_enum" type="bool" setter="" getter="" default="true"> + </member> <member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables warnings when dividing an integer by another integer (the decimal part will be discarded). </member> @@ -1329,10 +1331,10 @@ The policy to use for unhandled Mono (C#) exceptions. The default "Terminate Application" exits the project as soon as an unhandled exception is thrown. "Log Error" logs an error message to the console instead, and will not interrupt the project execution when an unhandled exception is thrown. [b]Note:[/b] The unhandled exception policy is always set to "Log Error" in the editor, which also includes C# [code]tool[/code] scripts running within the editor as well as editor plugin code. </member> - <member name="navigation/2d/default_cell_size" type="int" setter="" getter="" default="10"> + <member name="navigation/2d/default_cell_size" type="int" setter="" getter="" default="1"> Default cell size for 2D navigation maps. See [method NavigationServer2D.map_set_cell_size]. </member> - <member name="navigation/2d/default_edge_connection_margin" type="int" setter="" getter="" default="5"> + <member name="navigation/2d/default_edge_connection_margin" type="int" setter="" getter="" default="1"> Default edge connection margin for 2D navigation maps. See [method NavigationServer2D.map_set_edge_connection_margin]. </member> <member name="navigation/3d/default_cell_size" type="float" setter="" getter="" default="0.3"> @@ -1412,8 +1414,8 @@ Sets which physics engine to use for 2D physics. "DEFAULT" and "GodotPhysics2D" are the same, as there is currently no alternative 2D physics server implemented. </member> - <member name="physics/2d/run_on_thread" type="bool" setter="" getter="" default="false"> - Sets whether 2D physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. + <member name="physics/2d/run_on_separate_thread" type="bool" setter="" getter="" default="false"> + If [code]true[/code], the 2D physics server runs on a separate thread, making better use of multi-core CPUs. If [code]false[/code], the 2D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. </member> <member name="physics/2d/sleep_threshold_angular" type="float" setter="" getter="" default="0.139626"> Threshold angular velocity under which a 2D physics body will be considered inactive. See [constant PhysicsServer2D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD]. @@ -1484,8 +1486,8 @@ Sets which physics engine to use for 3D physics. "DEFAULT" is currently the [url=https://bulletphysics.org]Bullet[/url] physics engine. The "GodotPhysics3D" engine is still supported as an alternative. </member> - <member name="physics/3d/run_on_thread" type="bool" setter="" getter="" default="false"> - Sets whether 3D physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process. + <member name="physics/3d/run_on_separate_thread" type="bool" setter="" getter="" default="false"> + If [code]true[/code], the 3D physics server runs on a separate thread, making better use of multi-core CPUs. If [code]false[/code], the 3D physics server runs on the main thread. Running the physics server on a separate thread can increase performance, but restricts API access to only physics process. </member> <member name="physics/3d/sleep_threshold_angular" type="float" setter="" getter="" default="0.139626"> Threshold angular velocity under which a 3D physics body will be considered inactive. See [constant PhysicsServer3D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index fe2885378a..27e02d0ee5 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -16,9 +16,9 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject2D" /> <description> - Adds a collision exception so the ray does not report collisions with the specified node. + Adds a collision exception so the ray does not report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="add_exception_rid"> @@ -81,9 +81,9 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject2D" /> <description> - Removes a collision exception so the ray does report collisions with the specified node. + Removes a collision exception so the ray does report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="remove_exception_rid"> diff --git a/doc/classes/RayCast3D.xml b/doc/classes/RayCast3D.xml index 8973857ace..6be5861b84 100644 --- a/doc/classes/RayCast3D.xml +++ b/doc/classes/RayCast3D.xml @@ -17,9 +17,9 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject3D" /> <description> - Adds a collision exception so the ray does not report collisions with the specified node. + Adds a collision exception so the ray does not report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="add_exception_rid"> @@ -82,9 +82,9 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject3D" /> <description> - Removes a collision exception so the ray does report collisions with the specified node. + Removes a collision exception so the ray does report collisions with the specified [CollisionObject3D] node. </description> </method> <method name="remove_exception_rid"> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 65d1654c21..6285b1d155 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -93,7 +93,7 @@ <method name="get_area" qualifiers="const"> <return type="float" /> <description> - Returns the area of the [Rect2]. + Returns the area of the [Rect2]. See also [method has_no_area]. </description> </method> <method name="get_center" qualifiers="const"> @@ -130,7 +130,8 @@ <method name="has_no_area" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [Rect2] is flat or empty. + Returns [code]true[/code] if the [Rect2] is flat or empty, [code]false[/code] otherwise. See also [method get_area]. + [b]Note:[/b] If the [Rect2] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code]. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml index 5909784135..a542bad82b 100644 --- a/doc/classes/Rect2i.xml +++ b/doc/classes/Rect2i.xml @@ -70,7 +70,7 @@ <return type="Rect2i" /> <argument index="0" name="to" type="Vector2i" /> <description> - Returns a copy of this [Rect2i] expanded to include a given point. + Returns a copy of this [Rect2i] expanded so that the borders align with the given point. [codeblocks] [gdscript] # position (-3, 2), size (1, 1) @@ -90,7 +90,7 @@ <method name="get_area" qualifiers="const"> <return type="int" /> <description> - Returns the area of the [Rect2i]. + Returns the area of the [Rect2i]. See also [method has_no_area]. </description> </method> <method name="get_center" qualifiers="const"> @@ -128,7 +128,8 @@ <method name="has_no_area" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the [Rect2i] is flat or empty. + Returns [code]true[/code] if the [Rect2i] is flat or empty, [code]false[/code] otherwise. See also [method get_area]. + [b]Note:[/b] If the [Rect2i] has a negative size and is not flat or empty, [method has_no_area] will return [code]true[/code]. </description> </method> <method name="has_point" qualifiers="const"> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml index 5d207c0db7..63f436fa03 100644 --- a/doc/classes/ReflectionProbe.xml +++ b/doc/classes/ReflectionProbe.xml @@ -43,6 +43,7 @@ </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="0.0"> The maximum distance away from the [ReflectionProbe] an object can be before it is culled. Decrease this to improve performance, especially when using the [constant UPDATE_ALWAYS] [member update_mode]. + [b]Note:[/b] The maximum reflection distance is always at least equal to the [member extents]. This means that decreasing [member max_distance] will not always cull objects from reflections, especially if the reflection probe's [member extents] are already large. </member> <member name="mesh_lod_threshold" type="float" setter="set_mesh_lod_threshold" getter="get_mesh_lod_threshold" default="1.0"> The automatic LOD bias to use for meshes rendered within the [ReflectionProbe] (this is analog to [member Viewport.mesh_lod_threshold]). Higher values will use less detailed versions of meshes that have LOD variations generated. If set to [code]0.0[/code], automatic LOD is disabled. Increase [member mesh_lod_threshold] to improve performance at the cost of geometry detail, especially when using the [constant UPDATE_ALWAYS] [member update_mode]. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index ff370bd953..446db40dd8 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -994,6 +994,8 @@ <argument index="8" name="hdr_bleed_threshold" type="float" /> <argument index="9" name="hdr_bleed_scale" type="float" /> <argument index="10" name="hdr_luminance_cap" type="float" /> + <argument index="11" name="glow_map_strength" type="float" /> + <argument index="12" name="glow_map" type="RID" /> <description> </description> </method> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 6f5135459f..95dffd3e28 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -372,6 +372,9 @@ </method> </methods> <members> + <member name="autowrap_mode" type="int" setter="set_autowrap_mode" getter="get_autowrap_mode" enum="RichTextLabel.AutowrapMode" default="3"> + If set to something other than [constant AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see [enum AutowrapMode]. + </member> <member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode" default="false"> If [code]true[/code], the label uses BBCode formatting. </member> @@ -454,6 +457,18 @@ </signal> </signals> <constants> + <constant name="AUTOWRAP_OFF" value="0" enum="AutowrapMode"> + Autowrap is disabled. + </constant> + <constant name="AUTOWRAP_ARBITRARY" value="1" enum="AutowrapMode"> + Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available. + </constant> + <constant name="AUTOWRAP_WORD" value="2" enum="AutowrapMode"> + Wraps the text inside the node's bounding rectangle by soft-breaking between words. + </constant> + <constant name="AUTOWRAP_WORD_SMART" value="3" enum="AutowrapMode"> + Behaves similarly to [constant AUTOWRAP_WORD], but force-breaks a word if that single word does not fit in one line. + </constant> <constant name="LIST_NUMBERS" value="0" enum="ListType"> Each list item has a number marker. </constant> diff --git a/doc/classes/SceneReplicationConfig.xml b/doc/classes/SceneReplicationConfig.xml new file mode 100644 index 0000000000..e846740dd3 --- /dev/null +++ b/doc/classes/SceneReplicationConfig.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SceneReplicationConfig" inherits="Resource" version="4.0"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_property"> + <return type="void" /> + <argument index="0" name="path" type="NodePath" /> + <argument index="1" name="index" type="int" default="-1" /> + <description> + </description> + </method> + <method name="get_properties" qualifiers="const"> + <return type="NodePath[]" /> + <description> + </description> + </method> + <method name="property_get_index" qualifiers="const"> + <return type="int" /> + <argument index="0" name="path" type="NodePath" /> + <description> + </description> + </method> + <method name="property_get_spawn"> + <return type="bool" /> + <argument index="0" name="path" type="NodePath" /> + <description> + </description> + </method> + <method name="property_get_sync"> + <return type="bool" /> + <argument index="0" name="path" type="NodePath" /> + <description> + </description> + </method> + <method name="property_set_spawn"> + <return type="void" /> + <argument index="0" name="path" type="NodePath" /> + <argument index="1" name="enabled" type="bool" /> + <description> + </description> + </method> + <method name="property_set_sync"> + <return type="void" /> + <argument index="0" name="path" type="NodePath" /> + <argument index="1" name="enabled" type="bool" /> + <description> + </description> + </method> + <method name="remove_property"> + <return type="void" /> + <argument index="0" name="path" type="NodePath" /> + <description> + </description> + </method> + </methods> +</class> diff --git a/doc/classes/ShapeCast2D.xml b/doc/classes/ShapeCast2D.xml index 74ebafe069..7229d6f72a 100644 --- a/doc/classes/ShapeCast2D.xml +++ b/doc/classes/ShapeCast2D.xml @@ -14,9 +14,9 @@ <methods> <method name="add_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject2D" /> <description> - Adds a collision exception so the shape does not report collisions with the specified node. + Adds a collision exception so the shape does not report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="add_exception_rid"> @@ -101,9 +101,9 @@ </method> <method name="remove_exception"> <return type="void" /> - <argument index="0" name="node" type="Object" /> + <argument index="0" name="node" type="CollisionObject2D" /> <description> - Removes a collision exception so the shape does report collisions with the specified node. + Removes a collision exception so the shape does report collisions with the specified [CollisionObject2D] node. </description> </method> <method name="remove_exception_rid"> diff --git a/doc/classes/SoftDynamicBody3D.xml b/doc/classes/SoftDynamicBody3D.xml index fceebddf35..801b25f1b0 100644 --- a/doc/classes/SoftDynamicBody3D.xml +++ b/doc/classes/SoftDynamicBody3D.xml @@ -5,6 +5,7 @@ </brief_description> <description> A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials. + [b]Note:[/b] There are many known bugs in [SoftDynamicBody3D]. Therefore, it's not recommended to use them for things that can affect gameplay (such as a player character made entirely out of soft bodies). </description> <tutorials> <link title="SoftBody">$DOCS_URL/tutorials/physics/soft_body.html</link> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 989864760f..e335987ff5 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="StreamPeerBuffer" inherits="StreamPeer" version="4.0"> <brief_description> + Data buffer stream peer. </brief_description> <description> + Data buffer stream peer that uses a byte array as the stream. This object can be used to handle binary data from network sessions. To handle binary data stored in files, [File] can be used directly. + A [StreamPeerBuffer] object keeps an internal cursor which is the offset in bytes to the start of the buffer. Get and put operations are performed at the cursor position and will move the cursor accordingly. </description> <tutorials> </tutorials> @@ -10,38 +13,45 @@ <method name="clear"> <return type="void" /> <description> + Clears the [member data_array] and resets the cursor. </description> </method> <method name="duplicate" qualifiers="const"> <return type="StreamPeerBuffer" /> <description> + Returns a new [StreamPeerBuffer] with the same [member data_array] content. </description> </method> <method name="get_position" qualifiers="const"> <return type="int" /> <description> + Returns the current cursor position. </description> </method> <method name="get_size" qualifiers="const"> <return type="int" /> <description> + Returns the size of [member data_array]. </description> </method> <method name="resize"> <return type="void" /> <argument index="0" name="size" type="int" /> <description> + Resizes the [member data_array]. This [i]doesn't[/i] update the cursor. </description> </method> <method name="seek"> <return type="void" /> <argument index="0" name="position" type="int" /> <description> + Moves the cursor to the specified position. [code]position[/code] must be a valid index of [member data_array]. </description> </method> </methods> <members> <member name="data_array" type="PackedByteArray" setter="set_data_array" getter="get_data_array" default="PackedByteArray()"> + The underlying data buffer. Setting this value resets the cursor. </member> </members> </class> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index c8e835f0f1..eeb17c24c0 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -103,6 +103,13 @@ <description> </description> </method> + <method name="contains" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="what" type="String" /> + <description> + Returns [code]true[/code] if the string contains the given string. + </description> + </method> <method name="count" qualifiers="const"> <return type="int" /> <argument index="0" name="what" type="String" /> @@ -285,7 +292,7 @@ Returns [code]true[/code] if this string is a subsequence of the given string. </description> </method> - <method name="is_subsequence_ofi" qualifiers="const"> + <method name="is_subsequence_ofn" qualifiers="const"> <return type="bool" /> <argument index="0" name="text" type="String" /> <description> diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml index 59a4743d80..c286629395 100644 --- a/doc/classes/TabBar.xml +++ b/doc/classes/TabBar.xml @@ -43,10 +43,11 @@ Returns the previously active tab index. </description> </method> - <method name="get_select_with_rmb" qualifiers="const"> - <return type="bool" /> + <method name="get_tab_button_icon" qualifiers="const"> + <return type="Texture2D" /> + <argument index="0" name="tab_idx" type="int" /> <description> - Returns [code]true[/code] if select with right mouse button is enabled. + Returns the [Texture2D] for the right button of the tab at index [code]tab_idx[/code] or [code]null[/code] if the button has no [Texture2D]. </description> </method> <method name="get_tab_icon" qualifiers="const"> @@ -111,6 +112,13 @@ Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. </description> </method> + <method name="is_tab_hidden" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="tab_idx" type="int" /> + <description> + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden. + </description> + </method> <method name="move_tab"> <return type="void" /> <argument index="0" name="from" type="int" /> @@ -126,11 +134,12 @@ Removes the tab at index [code]tab_idx[/code]. </description> </method> - <method name="set_select_with_rmb"> + <method name="set_tab_button_icon"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <argument index="0" name="tab_idx" type="int" /> + <argument index="1" name="icon" type="Texture2D" /> <description> - If [code]true[/code], enables selecting a tab with the right mouse button. + Sets an [code]icon[/code] for the button of the tab at index [code]tab_idx[/code] (located to the right, before the close button), making it visible and clickable (See [signal tab_button_pressed]). Giving it a [code]null[/code] value will hide the button. </description> </method> <method name="set_tab_disabled"> @@ -141,6 +150,14 @@ If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable. </description> </method> + <method name="set_tab_hidden"> + <return type="void" /> + <argument index="0" name="tab_idx" type="int" /> + <argument index="1" name="hidden" type="bool" /> + <description> + If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area. + </description> + </method> <method name="set_tab_icon"> <return type="void" /> <argument index="0" name="tab_idx" type="int" /> @@ -200,10 +217,17 @@ <member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled" default="false"> If [code]true[/code], tabs can be rearranged with mouse drag. </member> + <member name="scroll_to_selected" type="bool" setter="set_scroll_to_selected" getter="get_scroll_to_selected" default="true"> + If [code]true[/code], the tab offset will be changed to keep the the currently selected tab visible. + </member> <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled" default="true"> if [code]true[/code], the mouse's scroll wheel can be used to navigate the scroll view. </member> + <member name="select_with_rmb" type="bool" setter="set_select_with_rmb" getter="get_select_with_rmb" default="false"> + If [code]true[/code], enables selecting a tab with the right mouse button. + </member> <member name="tab_alignment" type="int" setter="set_tab_alignment" getter="get_tab_alignment" enum="TabBar.AlignmentMode" default="1"> + Sets the position at which tabs will be placed. See [enum AlignmentMode] for details. </member> <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="TabBar.CloseButtonDisplayPolicy" default="0"> Sets when the close button will appear on the tabs. See [enum CloseButtonDisplayPolicy] for details. @@ -219,6 +243,12 @@ Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. </description> </signal> + <signal name="tab_button_pressed"> + <argument index="0" name="tab" type="int" /> + <description> + Emitted when a tab's right button is pressed. See [method set_tab_button_icon]. + </description> + </signal> <signal name="tab_changed"> <argument index="0" name="tab" type="int" /> <description> @@ -255,18 +285,28 @@ <signal name="tab_rmb_clicked"> <argument index="0" name="tab" type="int" /> <description> - Emitted when a tab is right-clicked. + Emitted when a tab is right-clicked. [member select_with_rmb] must be enabled. + </description> + </signal> + <signal name="tab_selected"> + <argument index="0" name="tab" type="int" /> + <description> + Emitted when a tab is selected via click or script, even if it is the current tab. </description> </signal> </signals> <constants> <constant name="ALIGNMENT_LEFT" value="0" enum="AlignmentMode"> + Places tabs to the left. </constant> <constant name="ALIGNMENT_CENTER" value="1" enum="AlignmentMode"> + Places tabs in the middle. </constant> <constant name="ALIGNMENT_RIGHT" value="2" enum="AlignmentMode"> + Places tabs to the right. </constant> <constant name="ALIGNMENT_MAX" value="3" enum="AlignmentMode"> + Represents the size of the [enum AlignmentMode] enum. </constant> <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0" enum="CloseButtonDisplayPolicy"> Never show the close buttons. @@ -321,11 +361,11 @@ <theme_item name="increment_highlight" data_type="icon" type="Texture2D"> Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. </theme_item> - <theme_item name="close_bg_highlight" data_type="style" type="StyleBox"> - Background of the close button when it's being hovered with the cursor. + <theme_item name="button_highlight" data_type="style" type="StyleBox"> + Background of the tab and close buttons when they're being hovered with the cursor. </theme_item> - <theme_item name="close_bg_pressed" data_type="style" type="StyleBox"> - Background of the close button when it's being pressed. + <theme_item name="button_pressed" data_type="style" type="StyleBox"> + Background of the tab and close buttons when it's being pressed. </theme_item> <theme_item name="tab_disabled" data_type="style" type="StyleBox"> The style of disabled tabs. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 5f887a397f..6b9eb6efc3 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -992,6 +992,9 @@ <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color" default="false"> If [code]true[/code], custom [code]font_selected_color[/code] will be used for selected text. </member> + <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder" default=""""> + Text shown when the [TextEdit] is empty. It is [b]not[/b] the [TextEdit]'s default value (see [member text]). + </member> <member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0"> If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels. </member> @@ -1231,6 +1234,9 @@ <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the [TextEdit]. </theme_item> + <theme_item name="font_placeholder_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.6)"> + Font color for [member placeholder_text]. + </theme_item> <theme_item name="font_readonly_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)"> Sets the font [Color] when [member editable] is disabled. </theme_item> diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml index bf1abf86ae..7bfc7eed7e 100644 --- a/doc/classes/TextLine.xml +++ b/doc/classes/TextLine.xml @@ -26,6 +26,7 @@ <argument index="2" name="size" type="int" /> <argument index="3" name="opentype_features" type="Dictionary" default="{}" /> <argument index="4" name="language" type="String" default="""" /> + <argument index="5" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it. </description> diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index 3d3c0dd6ff..acf3dcd43b 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -26,6 +26,7 @@ <argument index="2" name="size" type="int" /> <argument index="3" name="opentype_features" type="Dictionary" default="{}" /> <argument index="4" name="language" type="String" default="""" /> + <argument index="5" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it. </description> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 61024ef0c8..9025e4ff2a 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -896,6 +896,32 @@ [b]Note:[/b] This function is used by during project export, to include TextServer database. </description> </method> + <method name="shaped_get_span_count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. + </description> + </method> + <method name="shaped_get_span_meta" qualifiers="const"> + <return type="Variant" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="index" type="int" /> + <description> + Returns text span metadata. + </description> + </method> + <method name="shaped_set_span_update_font"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="index" type="int" /> + <argument index="2" name="fonts" type="Array" /> + <argument index="3" name="size" type="int" /> + <argument index="4" name="opentype_features" type="Dictionary" default="{}" /> + <description> + Changes text span font, font size and OpenType features, without changing the text. + </description> + </method> <method name="shaped_text_add_object"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> @@ -915,6 +941,7 @@ <argument index="3" name="size" type="int" /> <argument index="4" name="opentype_features" type="Dictionary" default="{}" /> <argument index="5" name="language" type="String" default="""" /> + <argument index="6" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it to the text buffer. </description> diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index 8b4825026d..b500bd5658 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -202,7 +202,7 @@ </description> </method> <method name="_font_get_hinting" qualifiers="virtual const"> - <return type="int" /> + <return type="int" enum="TextServer.Hinting" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns the font hinting mode. Used by dynamic fonts only. @@ -904,6 +904,32 @@ [b]Note:[/b] This function is used by during project export, to include TextServer database. </description> </method> + <method name="_shaped_get_span_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of text spans added using [method _shaped_text_add_string] or [method _shaped_text_add_object]. + </description> + </method> + <method name="_shaped_get_span_meta" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="index" type="int" /> + <description> + Returns text span metadata. + </description> + </method> + <method name="_shaped_set_span_update_font" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="index" type="int" /> + <argument index="2" name="fonts" type="Array" /> + <argument index="3" name="size" type="int" /> + <argument index="4" name="opentype_features" type="Dictionary" /> + <description> + Changes text span font, font size and OpenType features, without changing the text. + </description> + </method> <method name="_shaped_text_add_object" qualifiers="virtual"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> @@ -923,6 +949,7 @@ <argument index="3" name="size" type="int" /> <argument index="4" name="opentype_features" type="Dictionary" /> <argument index="5" name="language" type="String" /> + <argument index="6" name="meta" type="Variant" /> <description> Adds text span and font to draw it to the text buffer. </description> @@ -1001,7 +1028,7 @@ </description> </method> <method name="_shaped_text_get_direction" qualifiers="virtual const"> - <return type="int" /> + <return type="int" enum="TextServer.Direction" /> <argument index="0" name="shaped" type="RID" /> <description> Returns direction of the text. @@ -1024,9 +1051,8 @@ </description> </method> <method name="_shaped_text_get_ellipsis_glyphs" qualifiers="virtual const"> - <return type="void" /> + <return type="Glyph*" /> <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="r_glyphs" type="void*" /> <description> Returns array of the glyphs in the ellipsis. </description> @@ -1046,9 +1072,8 @@ </description> </method> <method name="_shaped_text_get_glyphs" qualifiers="virtual const"> - <return type="void" /> + <return type="Glyph*" /> <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="r_glyphs" type="void*" /> <description> Copies text glyphs in the visual order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. </description> @@ -1062,7 +1087,7 @@ </description> </method> <method name="_shaped_text_get_inferred_direction" qualifiers="virtual const"> - <return type="int" /> + <return type="int" enum="TextServer.Direction" /> <argument index="0" name="shaped" type="RID" /> <description> Returns direction of the text, inferred by the BiDi algorithm. @@ -1105,7 +1130,7 @@ </description> </method> <method name="_shaped_text_get_orientation" qualifiers="virtual const"> - <return type="int" /> + <return type="int" enum="TextServer.Orientation" /> <argument index="0" name="shaped" type="RID" /> <description> Returns text orientation. @@ -1310,9 +1335,8 @@ </description> </method> <method name="_shaped_text_sort_logical" qualifiers="virtual"> - <return type="void" /> + <return type="Glyph*" /> <argument index="0" name="shaped" type="RID" /> - <argument index="1" name="r_glyphs" type="void*" /> <description> Copies text glyphs in the logical order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. </description> diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml index 476ab2d1bf..5f081b95f5 100644 --- a/doc/classes/TextureButton.xml +++ b/doc/classes/TextureButton.xml @@ -12,17 +12,17 @@ <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <members> - <member name="expand" type="bool" setter="set_expand" getter="get_expand" default="false"> - If [code]true[/code], the texture stretches to the edges of the node's bounding rectangle using the [member stretch_mode]. If [code]false[/code], the texture will not scale with the node. - </member> <member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h" default="false"> If [code]true[/code], texture is flipped horizontally. </member> <member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v" default="false"> If [code]true[/code], texture is flipped vertically. </member> - <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode" default="0"> - Controls the texture's behavior when you resize the node's bounding rectangle, [b]only if[/b] [member expand] is [code]true[/code]. Set it to one of the [enum StretchMode] constants. See the constants to learn more. + <member name="ignore_texture_size" type="bool" setter="set_ignore_texture_size" getter="get_ignore_texture_size" default="false"> + If [code]true[/code], the size of the texture won't be considered for minimum size calculation, so the [TextureButton] can be shrunk down past the texture size. + </member> + <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode" default="2"> + Controls the texture's behavior when you resize the node's bounding rectangle. See the [enum StretchMode] constants for available options. </member> <member name="texture_click_mask" type="BitMap" setter="set_click_mask" getter="get_click_mask"> Pure black and white [BitMap] image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes. diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index d1a48fda55..b1367be263 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -1,20 +1,22 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Theme" inherits="Resource" version="4.0"> <brief_description> - Theme for controls. + Theme resource for styling/skinning [Control]s and [Window]s. </brief_description> <description> - A theme for skinning controls. Controls can be skinned individually, but for complex applications, it's more practical to just create a global theme that defines everything. This theme can be applied to any [Control]; the Control and its children will automatically use it. - Theme resources can alternatively be loaded by writing them in a [code].theme[/code] file, see the documentation for more information. + A theme resource is used for styling/skinning [Control] and [Window] nodes. While individual controls can be styled using their local theme overrides (see [method Control.add_theme_color_override]), theme resources allow you to store and apply the same settings between all controls sharing the same type (e.g. style all [Button]s the same). One theme resource can be used for the entire project, but you can also set a separate theme resource to a branch of control nodes. A theme resources assigned to a control node applies to the control itself, as well as all of its direct and indirect children (as long as a chain of controls is uninterrupted). + Use [member ProjectSettings.gui/theme/custom] to set up a project-scope theme that will be available to every control in your project. + Use [member Control.theme] of any control node to set up a theme that will be available to that control and all of its direct and indirect children. </description> <tutorials> <link title="GUI skinning">$DOCS_URL/tutorials/ui/gui_skinning.html</link> + <link title="Using the theme editor">$DOCS_URL/tutorials/ui/gui_using_theme_editor.html</link> </tutorials> <methods> <method name="clear"> <return type="void" /> <description> - Clears all values on the theme. + Removes all the theme properties defined on the theme resource. </description> </method> <method name="clear_color"> @@ -22,7 +24,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_color] to check for existence. </description> </method> <method name="clear_constant"> @@ -30,7 +33,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears the constant at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_constant] to check for existence. </description> </method> <method name="clear_font"> @@ -38,7 +42,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_font] to check for existence. </description> </method> <method name="clear_font_size"> @@ -46,7 +51,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears the font size [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_font_size] to check for existence. </description> </method> <method name="clear_icon"> @@ -54,7 +60,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears the icon at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_icon] to check for existence. </description> </method> <method name="clear_stylebox"> @@ -62,7 +69,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Clears [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_stylebox] to check for existence. </description> </method> <method name="clear_theme_item"> @@ -71,14 +79,16 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]theme_type[/code]. + Removes the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Fails if it doesn't exist. Use [method has_theme_item] to check for existence. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="clear_type_variation"> <return type="void" /> <argument index="0" name="theme_type" type="StringName" /> <description> - Unmarks [code]theme_type[/code] as being a variation of any other type. + Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation]. </description> </method> <method name="get_color" qualifiers="const"> @@ -86,20 +96,21 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the [Color] at [code]name[/code] if the theme has [code]theme_type[/code]. + Returns the [Color] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the default color value if the property doesn't exist. Use [method has_color] to check for existence. </description> </method> <method name="get_color_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the [Color]s as a [PackedStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]theme_type[/code]. + Returns a list of names for [Color] properties defined with [code]theme_type[/code]. Use [method get_color_type_list] to get a list of possible theme type names. </description> </method> <method name="get_color_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the [Color] types as a [PackedStringArray] filled with unique type names, for use in [method get_color] and/or [method get_color_list]. + Returns a list of all unique theme type names for [Color] properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_constant" qualifiers="const"> @@ -107,20 +118,21 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the constant at [code]name[/code] if the theme has [code]theme_type[/code]. + Returns the constant property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns [code]0[/code] if the property doesn't exist. Use [method has_constant] to check for existence. </description> </method> <method name="get_constant_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the constants as a [PackedStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]theme_type[/code]. + Returns a list of names for constant properties defined with [code]theme_type[/code]. Use [method get_constant_type_list] to get a list of possible theme type names. </description> </method> <method name="get_constant_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the constant types as a [PackedStringArray] filled with unique type names, for use in [method get_constant] and/or [method get_constant_list]. + Returns a list of all unique theme type names for constant properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_font" qualifiers="const"> @@ -128,14 +140,16 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the [Font] at [code]name[/code] if the theme has [code]theme_type[/code]. + Returns the [Font] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the default theme font if the property doesn't exist and the default theme font is set up (see [member default_font]). Use [method has_font] to check for existence of the property and [method has_default_font] to check for existence of the default theme font. + Returns the engine fallback font value, if neither exist. </description> </method> <method name="get_font_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the [Font]s as a [PackedStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]theme_type[/code]. + Returns a list of names for [Font] properties defined with [code]theme_type[/code]. Use [method get_font_type_list] to get a list of possible theme type names. </description> </method> <method name="get_font_size" qualifiers="const"> @@ -143,26 +157,28 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the font size at [code]name[/code] if the theme has [code]theme_type[/code]. + Returns the font size property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see [member default_font_size]). Use [method has_font_size] to check for existence of the property and [method has_default_font_size] to check for existence of the default theme font. + Returns the engine fallback font size value, if neither exist. </description> </method> <method name="get_font_size_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the font sizes as a [PackedStringArray] filled with each font size name, for use in [method get_font_size], if the theme has [code]theme_type[/code]. + Returns a list of names for font size properties defined with [code]theme_type[/code]. Use [method get_font_size_type_list] to get a list of possible theme type names. </description> </method> <method name="get_font_size_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the font size types as a [PackedStringArray] filled with unique type names, for use in [method get_font_size] and/or [method get_font_size_list]. + Returns a list of all unique theme type names for font size properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_font_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the [Font] types as a [PackedStringArray] filled with unique type names, for use in [method get_font] and/or [method get_font_list]. + Returns a list of all unique theme type names for [Font] properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_icon" qualifiers="const"> @@ -170,20 +186,21 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the icon [Texture2D] at [code]name[/code] if the theme has [code]theme_type[/code]. + Returns the icon property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the engine fallback icon value if the property doesn't exist. Use [method has_icon] to check for existence. </description> </method> <method name="get_icon_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the icons as a [PackedStringArray] filled with each [Texture2D]'s name, for use in [method get_icon], if the theme has [code]theme_type[/code]. + Returns a list of names for icon properties defined with [code]theme_type[/code]. Use [method get_icon_type_list] to get a list of possible theme type names. </description> </method> <method name="get_icon_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the icon types as a [PackedStringArray] filled with unique type names, for use in [method get_icon] and/or [method get_icon_list]. + Returns a list of all unique theme type names for icon properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -191,22 +208,21 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns the [StyleBox] at [code]name[/code] if the theme has [code]theme_type[/code]. - Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]theme_type[/code]s may be found using [method get_stylebox_type_list]. + Returns the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the engine fallback stylebox value if the property doesn't exist. Use [method has_stylebox] to check for existence. </description> </method> <method name="get_stylebox_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="theme_type" type="String" /> <description> - Returns all the [StyleBox]s as a [PackedStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]theme_type[/code]. - Valid [code]theme_type[/code]s may be found using [method get_stylebox_type_list]. + Returns a list of names for [StyleBox] properties defined with [code]theme_type[/code]. Use [method get_stylebox_type_list] to get a list of possible theme type names. </description> </method> <method name="get_stylebox_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the [StyleBox] types as a [PackedStringArray] filled with unique type names, for use in [method get_stylebox] and/or [method get_stylebox_list]. + Returns a list of all unique theme type names for [StyleBox] properties. Use [method get_type_list] to get a list of all unique theme types. </description> </method> <method name="get_theme_item" qualifiers="const"> @@ -215,8 +231,9 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]theme_type[/code]. - Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]theme_type[/code]s may be found using [method get_theme_item_type_list] or a data type specific method. + Returns the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code], if it exists. + Returns the engine fallback icon value if the property doesn't exist. Use [method has_theme_item] to check for existence. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="get_theme_item_list" qualifiers="const"> @@ -224,35 +241,36 @@ <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> <argument index="1" name="theme_type" type="String" /> <description> - Returns all the theme items of [code]data_type[/code] as a [PackedStringArray] filled with each theme items's name, for use in [method get_theme_item] or a data type specific method, if the theme has [code]theme_type[/code]. - Valid [code]theme_type[/code]s may be found using [method get_theme_item_type_list] or a data type specific method. + Returns a list of names for properties of [code]data_type[/code] defined with [code]theme_type[/code]. Use [method get_theme_item_type_list] to get a list of possible theme type names. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="get_theme_item_type_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="data_type" type="int" enum="Theme.DataType" /> <description> - Returns all the theme items of [code]data_type[/code] types as a [PackedStringArray] filled with unique type names, for use in [method get_theme_item], [method get_theme_item_list] or data type specific methods. + Returns a list of all unique theme type names for [code]data_type[/code] properties. Use [method get_type_list] to get a list of all unique theme types. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="get_type_list" qualifiers="const"> <return type="PackedStringArray" /> <description> - Returns all the theme types as a [PackedStringArray] filled with unique type names, for use in other [code]get_*[/code] functions of this theme. + Returns a list of all unique theme type names. Use the appropriate [code]get_*_type_list[/code] method to get a list of unique theme types for a single data type. </description> </method> <method name="get_type_variation_base" qualifiers="const"> <return type="StringName" /> <argument index="0" name="theme_type" type="StringName" /> <description> - Returns the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise. + Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise. </description> </method> <method name="get_type_variation_list" qualifiers="const"> <return type="PackedStringArray" /> <argument index="0" name="base_type" type="StringName" /> <description> - Returns a list of all variation for the given [code]base_type[/code]. + Returns a list of all type variations for the given [code]base_type[/code]. </description> </method> <method name="has_color" qualifiers="const"> @@ -260,8 +278,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the [Color] property defined by [code]name[/code] and [code]theme_type[/code] exists. + Returns [code]false[/code] if it doesn't exist. Use [method set_color] to define it. </description> </method> <method name="has_constant" qualifiers="const"> @@ -269,26 +287,29 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if constant with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the constant property defined by [code]name[/code] and [code]theme_type[/code] exists. + Returns [code]false[/code] if it doesn't exist. Use [method set_constant] to define it. </description> </method> <method name="has_default_base_scale" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if this theme has a valid [member default_base_scale] value. + Returns [code]true[/code] if [member default_base_scale] has a valid value. + Returns [code]false[/code] if it doesn't. The value must be greater than [code]0.0[/code] to be considered valid. </description> </method> <method name="has_default_font" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if this theme has a valid [member default_font] value. + Returns [code]true[/code] if [member default_font] has a valid value. + Returns [code]false[/code] if it doesn't. </description> </method> <method name="has_default_font_size" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if this theme has a valid [member default_font_size] value. + Returns [code]true[/code] if [member default_font_size] has a valid value. + Returns [code]false[/code] if it doesn't. The value must be greater than [code]0[/code] to be considered valid. </description> </method> <method name="has_font" qualifiers="const"> @@ -296,8 +317,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the [Font] property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font is set up (see [method has_default_font]). + Returns [code]false[/code] if neither exist. Use [method set_font] to define the property. </description> </method> <method name="has_font_size" qualifiers="const"> @@ -305,8 +326,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if font size with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the font size property defined by [code]name[/code] and [code]theme_type[/code] exists, or if the default theme font size is set up (see [method has_default_font_size]). + Returns [code]false[/code] if neither exist. Use [method set_font_size] to define the property. </description> </method> <method name="has_icon" qualifiers="const"> @@ -314,8 +335,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if icon [Texture2D] with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the icon property defined by [code]name[/code] and [code]theme_type[/code] exists. + Returns [code]false[/code] if it doesn't exist. Use [method set_icon] to define it. </description> </method> <method name="has_stylebox" qualifiers="const"> @@ -323,8 +344,8 @@ <argument index="0" name="name" type="StringName" /> <argument index="1" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code] exists. + Returns [code]false[/code] if it doesn't exist. Use [method set_stylebox] to define it. </description> </method> <method name="has_theme_item" qualifiers="const"> @@ -333,8 +354,9 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]theme_type[/code]. - Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. + Returns [code]true[/code] if the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code] exists. + Returns [code]false[/code] if it doesn't exist. Use [method set_theme_item] to define it. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="is_type_variation" qualifiers="const"> @@ -342,14 +364,14 @@ <argument index="0" name="theme_type" type="StringName" /> <argument index="1" name="base_type" type="StringName" /> <description> - Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code] in this theme. + Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code]. </description> </method> <method name="merge_with"> <return type="void" /> <argument index="0" name="other" type="Theme" /> <description> - Adds missing and overrides existing definitions with values from the [code]other[/code] [Theme]. + Adds missing and overrides existing definitions with values from the [code]other[/code] theme resource. [b]Note:[/b] This modifies the current theme. If you want to merge two themes together without modifying either one, create a new empty theme and merge the other two into it one after another. </description> </method> @@ -359,7 +381,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the [Color] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_color] to check for existence, and [method clear_color] to remove the existing property. </description> </method> <method name="rename_constant"> @@ -368,7 +391,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the constant property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_constant] to check for existence, and [method clear_constant] to remove the existing property. </description> </method> <method name="rename_font"> @@ -377,7 +401,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the [Font] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font] to check for existence, and [method clear_font] to remove the existing property. </description> </method> <method name="rename_font_size"> @@ -386,7 +411,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames the font size [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the font size property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font_size] to check for existence, and [method clear_font_size] to remove the existing property. </description> </method> <method name="rename_icon"> @@ -395,7 +421,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the icon property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_icon] to check for existence, and [method clear_icon] to remove the existing property. </description> </method> <method name="rename_stylebox"> @@ -404,7 +431,8 @@ <argument index="1" name="name" type="StringName" /> <argument index="2" name="theme_type" type="StringName" /> <description> - Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the [StyleBox] property defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_stylebox] to check for existence, and [method clear_stylebox] to remove the existing property. </description> </method> <method name="rename_theme_item"> @@ -414,7 +442,9 @@ <argument index="2" name="name" type="StringName" /> <argument index="3" name="theme_type" type="StringName" /> <description> - Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]theme_type[/code]. If [code]name[/code] is already taken, this method fails. + Renames the theme property of [code]data_type[/code] defined by [code]old_name[/code] and [code]theme_type[/code] to [code]name[/code], if it exists. + Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_theme_item] to check for existence, and [method clear_theme_item] to remove the existing property. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="set_color"> @@ -423,8 +453,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="color" type="Color" /> <description> - Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the [Color] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_color] to remove the property. </description> </method> <method name="set_constant"> @@ -433,8 +462,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="constant" type="int" /> <description> - Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the constant property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_constant] to remove the property. </description> </method> <method name="set_font"> @@ -443,8 +471,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="font" type="Font" /> <description> - Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the [Font] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_font] to remove the property. </description> </method> <method name="set_font_size"> @@ -453,8 +480,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="font_size" type="int" /> <description> - Sets the theme's font size to [code]font_size[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the font size property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_font_size] to remove the property. </description> </method> <method name="set_icon"> @@ -463,8 +489,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="texture" type="Texture2D" /> <description> - Sets the theme's icon [Texture2D] to [code]texture[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the icon property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_icon] to remove the property. </description> </method> <method name="set_stylebox"> @@ -473,8 +498,7 @@ <argument index="1" name="theme_type" type="StringName" /> <argument index="2" name="texture" type="StyleBox" /> <description> - Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]theme_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the [StyleBox] property defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_stylebox] to remove the property. </description> </method> <method name="set_theme_item"> @@ -484,9 +508,9 @@ <argument index="2" name="theme_type" type="StringName" /> <argument index="3" name="value" type="Variant" /> <description> - Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]theme_type[/code]. - Does nothing if the [code]value[/code] type does not match [code]data_type[/code]. - Creates [code]theme_type[/code] if the theme does not have it. + Creates or changes the value of the theme property of [code]data_type[/code] defined by [code]name[/code] and [code]theme_type[/code]. Use [method clear_theme_item] to remove the property. + Fails if the [code]value[/code] type is not accepted by [code]data_type[/code]. + [b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic. </description> </method> <method name="set_type_variation"> @@ -494,25 +518,25 @@ <argument index="0" name="theme_type" type="StringName" /> <argument index="1" name="base_type" type="StringName" /> <description> - Marks [code]theme_type[/code] as being a variation of [code]base_type[/code]. + Marks [code]theme_type[/code] as a variation of [code]base_type[/code]. This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class. - Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching a class of a [Control], the whole chain is going to be suggested as options. - [b]Note:[/b] Suggestions only show up if this [Theme] is set as the project default theme. See [member ProjectSettings.gui/theme/custom]. + Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching the class of the [Control], the whole chain is going to be suggested as options. + [b]Note:[/b] Suggestions only show up if this theme resource is set as the project default theme. See [member ProjectSettings.gui/theme/custom]. </description> </method> </methods> <members> <member name="default_base_scale" type="float" setter="set_default_base_scale" getter="get_default_base_scale" default="0.0"> - The default base scale factor of this [Theme] resource. Used by some controls to scale their visual properties based on a global scale factor. If this value is set to [code]0.0[/code], the global scale factor is used. + The default base scale factor of this theme resource. Used by some controls to scale their visual properties based on the global scale factor. If this value is set to [code]0.0[/code], the global scale factor is used. Use [method has_default_base_scale] to check if this value is valid. </member> <member name="default_font" type="Font" setter="set_default_font" getter="get_default_font"> - The default font of this [Theme] resource. Used as a fallback value for font items defined in this theme, but having invalid values. If this value is also invalid, the global default value is used. + The default font of this theme resource. Used as the default value when trying to fetch a font resource that doesn't exist in this theme or is in invalid state. If the default font is also missing or invalid, the engine fallback value is used. Use [method has_default_font] to check if this value is valid. </member> <member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1"> - The default font size of this [Theme] resource. Used as a fallback value for font size items defined in this theme, but having invalid values. If this value is set to [code]-1[/code], the global default value is used. - Use [method has_default_font_size] to check if this value is valid. + The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used. + Values below [code]0[/code] are invalid and can be used to unset the property. Use [method has_default_font_size] to check if this value is valid. </member> </members> <constants> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index e37031f3fd..80a6458cec 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -202,7 +202,8 @@ <return type="Vector2" /> <argument index="0" name="map_position" type="Vector2i" /> <description> - Returns the local position corresponding to the given tilemap (grid-based) coordinates. + Returns a local position of the center of the cell at the given tilemap (grid-based) coordinates. + [b]Note:[/b] This doesn't correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_offset] property of individual tiles. </description> </method> <method name="move_layer"> @@ -217,7 +218,7 @@ <return type="void" /> <argument index="0" name="layer" type="int" /> <description> - Moves the layer at index [code]layer_index[/code] to the given position [code]to_position[/code] in the array. + Removes the layer at index [code]layer[/code]. </description> </method> <method name="set_cell"> diff --git a/doc/classes/TileSetAtlasSource.xml b/doc/classes/TileSetAtlasSource.xml index 6580c6bd4c..f984d33098 100644 --- a/doc/classes/TileSetAtlasSource.xml +++ b/doc/classes/TileSetAtlasSource.xml @@ -111,7 +111,7 @@ </description> </method> <method name="get_tile_data" qualifiers="const"> - <return type="Object" /> + <return type="TileData" /> <argument index="0" name="atlas_coords" type="Vector2i" /> <argument index="1" name="alternative_tile" type="int" /> <description> diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index e679a8cfeb..ccecaaa6ac 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -106,6 +106,14 @@ Scales basis and origin of the transform by the given scale factor, using matrix multiplication. </description> </method> + <method name="sphere_interpolate_with" qualifiers="const"> + <return type="Transform3D" /> + <argument index="0" name="xform" type="Transform3D" /> + <argument index="1" name="weight" type="float" /> + <description> + Returns a transform spherically interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). + </description> + </method> <method name="translated" qualifiers="const"> <return type="Transform3D" /> <argument index="0" name="offset" type="Vector3" /> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 106bcf9d37..766c740a2c 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -50,10 +50,10 @@ </method> <method name="create_item"> <return type="TreeItem" /> - <argument index="0" name="parent" type="Object" default="null" /> + <argument index="0" name="parent" type="TreeItem" default="null" /> <argument index="1" name="idx" type="int" default="-1" /> <description> - Creates an item in the tree and adds it as a child of [code]parent[/code]. + Creates an item in the tree and adds it as a child of [code]parent[/code], which can be either a valid [TreeItem] or [code]null[/code]. If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. The new item will be the [code]idx[/code]th child of parent, or it will be the last child if there are not enough siblings. </description> @@ -170,10 +170,10 @@ </method> <method name="get_item_area_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="item" type="Object" /> + <argument index="0" name="item" type="TreeItem" /> <argument index="1" name="column" type="int" default="-1" /> <description> - Returns the rectangle area for the specified item. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. + Returns the rectangle area for the specified [TreeItem]. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. </description> </method> <method name="get_item_at_position" qualifiers="const"> @@ -185,9 +185,9 @@ </method> <method name="get_next_selected"> <return type="TreeItem" /> - <argument index="0" name="from" type="Object" /> + <argument index="0" name="from" type="TreeItem" /> <description> - Returns the next selected item after the given one, or [code]null[/code] if the end is reached. + Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached. If [code]from[/code] is [code]null[/code], this returns the first selected item. </description> </method> @@ -239,9 +239,9 @@ </method> <method name="scroll_to_item"> <return type="void" /> - <argument index="0" name="item" type="Object" /> + <argument index="0" name="item" type="TreeItem" /> <description> - Causes the [Tree] to jump to the specified item. + Causes the [Tree] to jump to the specified [TreeItem]. </description> </method> <method name="set_column_clip_content"> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 0090fb555f..12c91cdd10 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -371,7 +371,7 @@ </method> <method name="move_after"> <return type="void" /> - <argument index="0" name="item" type="Object" /> + <argument index="0" name="item" type="TreeItem" /> <description> Moves this TreeItem right after the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -379,7 +379,7 @@ </method> <method name="move_before"> <return type="void" /> - <argument index="0" name="item" type="Object" /> + <argument index="0" name="item" type="TreeItem" /> <description> Moves this TreeItem right before the given [code]item[/code]. [b]Note:[/b] You can't move to the root or move the root. @@ -390,12 +390,12 @@ <argument index="0" name="column" type="int" /> <argument index="1" name="emit_signal" type="bool" default="true" /> <description> - Propagates this item's checked status to its children and parents for the given [code]column[/code]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [code]emit_signal[/code] is set to false, then [signal Tree.check_propagated_to_item] will not be emitted. + Propagates this item's checked status to its children and parents for the given [code]column[/code]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [code]emit_signal[/code] is [code]false[/code], then [signal Tree.check_propagated_to_item] will not be emitted. </description> </method> <method name="remove_child"> <return type="void" /> - <argument index="0" name="child" type="Object" /> + <argument index="0" name="child" type="TreeItem" /> <description> Removes the given child [TreeItem] and all its children from the [Tree]. Note that it doesn't free the item from memory, so it can be reused later. To completely remove a [TreeItem] use [method Object.free]. </description> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 1cba995366..a1b53346d8 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -146,7 +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. + [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 or [PropertyTweener] with invalid node) are equivalent to infinite [code]while[/code] loops and will freeze your game. If a [Tween]'s lifetime depends on some node, always use [method bind_node]. </description> </method> <method name="set_parallel"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 4a11fbb489..7a60ca9fa6 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -55,7 +55,7 @@ <method name="get_mouse_position" qualifiers="const"> <return type="Vector2" /> <description> - Returns the mouse position relative to the viewport. + Returns the mouse's positon in this [Viewport] using the coordinate system of this [Viewport]. </description> </method> <method name="get_render_info"> @@ -107,6 +107,12 @@ Returns the drag data from the GUI, that was previously returned by [method Control._get_drag_data]. </description> </method> + <method name="gui_get_focus_owner"> + <return type="Control" /> + <description> + Returns the [Control] having the focus within this viewport. If no [Control] has the focus, returns null. + </description> + </method> <method name="gui_is_drag_successful" qualifiers="const"> <return type="bool" /> <description> @@ -119,6 +125,12 @@ Returns [code]true[/code] if the viewport is currently performing a drag operation. </description> </method> + <method name="gui_release_focus"> + <return type="void" /> + <description> + Removes the focus from the currently focussed [Control] within this viewport. If no [Control] has the focus, does nothing. + </description> + </method> <method name="is_embedding_subwindows" qualifiers="const"> <return type="bool" /> <description> @@ -168,7 +180,7 @@ <return type="void" /> <argument index="0" name="to_position" type="Vector2" /> <description> - Warps the mouse to a position relative to the viewport. + Moves the mouse pointer to the specified position in this [Viewport] using the coordinate system of this [Viewport]. </description> </method> </methods> diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index cebe7f215f..0067240820 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -47,6 +47,7 @@ <return type="void" /> <argument index="0" name="port" type="int" /> <argument index="1" name="value" type="Variant" /> + <argument index="2" name="prev_value" type="Variant" default="null" /> <description> Sets the default value for the selected input [code]port[/code]. </description> @@ -71,19 +72,22 @@ <constant name="PORT_TYPE_SCALAR_INT" value="1" enum="PortType"> Integer scalar. Translated to [code]int[/code] type in shader code. </constant> - <constant name="PORT_TYPE_VECTOR" value="2" enum="PortType"> + <constant name="PORT_TYPE_VECTOR_2D" value="2" enum="PortType"> + 2D vector of floating-point values. Translated to [code]vec2[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_VECTOR" value="3" enum="PortType"> 3D vector of floating-point values. Translated to [code]vec3[/code] type in shader code. </constant> - <constant name="PORT_TYPE_BOOLEAN" value="3" enum="PortType"> + <constant name="PORT_TYPE_BOOLEAN" value="4" enum="PortType"> Boolean type. Translated to [code]bool[/code] type in shader code. </constant> - <constant name="PORT_TYPE_TRANSFORM" value="4" enum="PortType"> + <constant name="PORT_TYPE_TRANSFORM" value="5" enum="PortType"> Transform type. Translated to [code]mat4[/code] type in shader code. </constant> - <constant name="PORT_TYPE_SAMPLER" value="5" enum="PortType"> + <constant name="PORT_TYPE_SAMPLER" value="6" enum="PortType"> Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes. </constant> - <constant name="PORT_TYPE_MAX" value="6" enum="PortType"> + <constant name="PORT_TYPE_MAX" value="7" enum="PortType"> Represents the size of the [enum PortType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeClamp.xml b/doc/classes/VisualShaderNodeClamp.xml index a68cbbec49..7219ba14b7 100644 --- a/doc/classes/VisualShaderNodeClamp.xml +++ b/doc/classes/VisualShaderNodeClamp.xml @@ -20,10 +20,13 @@ <constant name="OP_TYPE_INT" value="1" enum="OpType"> An integer scalar. </constant> - <constant name="OP_TYPE_VECTOR" value="2" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="2" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="4" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeCompare.xml b/doc/classes/VisualShaderNodeCompare.xml index 49bf952b31..ddd7f87cb8 100644 --- a/doc/classes/VisualShaderNodeCompare.xml +++ b/doc/classes/VisualShaderNodeCompare.xml @@ -10,7 +10,7 @@ </tutorials> <members> <member name="condition" type="int" setter="set_condition" getter="get_condition" enum="VisualShaderNodeCompare.Condition" default="0"> - Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR]. + Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR_3D]. </member> <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeCompare.Function" default="0"> A comparison function. See [enum Function] for options. @@ -26,16 +26,19 @@ <constant name="CTYPE_SCALAR_INT" value="1" enum="ComparisonType"> An integer scalar. </constant> - <constant name="CTYPE_VECTOR" value="2" enum="ComparisonType"> + <constant name="CTYPE_VECTOR_2D" value="2" enum="ComparisonType"> + A 2D vector type. + </constant> + <constant name="CTYPE_VECTOR_3D" value="3" enum="ComparisonType"> A 3D vector type. </constant> - <constant name="CTYPE_BOOLEAN" value="3" enum="ComparisonType"> + <constant name="CTYPE_BOOLEAN" value="4" enum="ComparisonType"> A boolean type. </constant> - <constant name="CTYPE_TRANSFORM" value="4" enum="ComparisonType"> + <constant name="CTYPE_TRANSFORM" value="5" enum="ComparisonType"> A transform ([code]mat4[/code]) type. </constant> - <constant name="CTYPE_MAX" value="5" enum="ComparisonType"> + <constant name="CTYPE_MAX" value="6" enum="ComparisonType"> Represents the size of the [enum ComparisonType] enum. </constant> <constant name="FUNC_EQUAL" value="0" enum="Function"> diff --git a/doc/classes/VisualShaderNodeDerivativeFunc.xml b/doc/classes/VisualShaderNodeDerivativeFunc.xml new file mode 100644 index 0000000000..704af44d04 --- /dev/null +++ b/doc/classes/VisualShaderNodeDerivativeFunc.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeDerivativeFunc" inherits="VisualShaderNode" version="4.0"> + <brief_description> + Calculates a derivative within the visual shader graph. + </brief_description> + <description> + This node is only available in [code]Fragment[/code] and [code]Light[/code] visual shaders. + </description> + <tutorials> + </tutorials> + <members> + <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeDerivativeFunc.Function" default="0"> + A derivative function type. See [enum Function] for options. + </member> + <member name="op_type" type="int" setter="set_op_type" getter="get_op_type" enum="VisualShaderNodeDerivativeFunc.OpType" default="0"> + A type of operands and returned value. See [enum OpType] for options. + </member> + </members> + <constants> + <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> + A floating-point scalar. + </constant> + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D" value="2" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + Represents the size of the [enum OpType] enum. + </constant> + <constant name="FUNC_SUM" value="0" enum="Function"> + Sum of absolute derivative in [code]x[/code] and [code]y[/code]. + </constant> + <constant name="FUNC_X" value="1" enum="Function"> + Derivative in [code]x[/code] using local differencing. + </constant> + <constant name="FUNC_Y" value="2" enum="Function"> + Derivative in [code]y[/code] using local differencing. + </constant> + <constant name="FUNC_MAX" value="3" enum="Function"> + Represents the size of the [enum Function] enum. + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeFaceForward.xml b/doc/classes/VisualShaderNodeFaceForward.xml index 80cb8aea4e..cd2b3972b7 100644 --- a/doc/classes/VisualShaderNodeFaceForward.xml +++ b/doc/classes/VisualShaderNodeFaceForward.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeFaceForward" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeFaceForward" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> Returns the vector that points in the same direction as a reference vector within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeMix.xml b/doc/classes/VisualShaderNodeMix.xml index 1ef580a983..8a2f289a11 100644 --- a/doc/classes/VisualShaderNodeMix.xml +++ b/doc/classes/VisualShaderNodeMix.xml @@ -15,15 +15,21 @@ </members> <constants> <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> - A scalar type. + A floating-point scalar. </constant> - <constant name="OP_TYPE_VECTOR" value="1" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_VECTOR_SCALAR" value="2" enum="OpType"> - A vector type. [code]weight[/code] port is using a scalar type. + <constant name="OP_TYPE_VECTOR_2D_SCALAR" value="2" enum="OpType"> + The [code]a[/code] and [code]b[/code] ports use a 2D vector type. The [code]weight[/code] port uses a scalar type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> + The [code]a[/code] and [code]b[/code] ports use a 3D vector type. The [code]weight[/code] port uses a scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="5" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeMultiplyAdd.xml b/doc/classes/VisualShaderNodeMultiplyAdd.xml index a0e9aef703..a6168e4df1 100644 --- a/doc/classes/VisualShaderNodeMultiplyAdd.xml +++ b/doc/classes/VisualShaderNodeMultiplyAdd.xml @@ -15,12 +15,15 @@ </members> <constants> <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> - A scalar type. + A floating-point scalar type. </constant> - <constant name="OP_TYPE_VECTOR" value="1" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_MAX" value="2" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="2" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="3" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml b/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml deleted file mode 100644 index 8d108a5d28..0000000000 --- a/doc/classes/VisualShaderNodeScalarDerivativeFunc.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeScalarDerivativeFunc" inherits="VisualShaderNode" version="4.0"> - <brief_description> - Calculates a scalar derivative within the visual shader graph. - </brief_description> - <description> - This node is only available in [code]Fragment[/code] and [code]Light[/code] visual shaders. - </description> - <tutorials> - </tutorials> - <members> - <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeScalarDerivativeFunc.Function" default="0"> - The derivative type. See [enum Function] for options. - </member> - </members> - <constants> - <constant name="FUNC_SUM" value="0" enum="Function"> - Sum of absolute derivative in [code]x[/code] and [code]y[/code]. - </constant> - <constant name="FUNC_X" value="1" enum="Function"> - Derivative in [code]x[/code] using local differencing. - </constant> - <constant name="FUNC_Y" value="2" enum="Function"> - Derivative in [code]y[/code] using local differencing. - </constant> - <constant name="FUNC_MAX" value="3" enum="Function"> - Represents the size of the [enum Function] enum. - </constant> - </constants> -</class> diff --git a/doc/classes/VisualShaderNodeSmoothStep.xml b/doc/classes/VisualShaderNodeSmoothStep.xml index 2f8c7e0f33..714b9d8267 100644 --- a/doc/classes/VisualShaderNodeSmoothStep.xml +++ b/doc/classes/VisualShaderNodeSmoothStep.xml @@ -16,15 +16,21 @@ </members> <constants> <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> - A scalar type. + A floating-point scalar type. </constant> - <constant name="OP_TYPE_VECTOR" value="1" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_VECTOR_SCALAR" value="2" enum="OpType"> - A vector type. [code]edge0[/code] and [code]edge1[/code] are using a scalar type. + <constant name="OP_TYPE_VECTOR_2D_SCALAR" value="2" enum="OpType"> + The [code]x[/code] port uses a 2D vector type. The first two ports use a floating-point scalar type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> + The [code]x[/code] port uses a 3D vector type. The first two ports use a floating-point scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="5" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeStep.xml b/doc/classes/VisualShaderNodeStep.xml index 5d8b464814..f65c95ea9e 100644 --- a/doc/classes/VisualShaderNodeStep.xml +++ b/doc/classes/VisualShaderNodeStep.xml @@ -16,15 +16,21 @@ </members> <constants> <constant name="OP_TYPE_SCALAR" value="0" enum="OpType"> - A scalar type. + A floating-point scalar type. </constant> - <constant name="OP_TYPE_VECTOR" value="1" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="1" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_VECTOR_SCALAR" value="2" enum="OpType"> - A vector type. [code]edge[/code] port is using a scalar type. + <constant name="OP_TYPE_VECTOR_2D_SCALAR" value="2" enum="OpType"> + The [code]x[/code] port uses a 2D vector type, while the [code]edge[/code] port uses a floating-point scalar type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> + The [code]x[/code] port uses a 3D vector type, while the [code]edge[/code] port uses a floating-point scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="5" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeSwitch.xml b/doc/classes/VisualShaderNodeSwitch.xml index 921092cd07..71888ec2c3 100644 --- a/doc/classes/VisualShaderNodeSwitch.xml +++ b/doc/classes/VisualShaderNodeSwitch.xml @@ -20,16 +20,19 @@ <constant name="OP_TYPE_INT" value="1" enum="OpType"> An integer scalar. </constant> - <constant name="OP_TYPE_VECTOR" value="2" enum="OpType"> - A vector type. + <constant name="OP_TYPE_VECTOR_2D" value="2" enum="OpType"> + A 2D vector type. </constant> - <constant name="OP_TYPE_BOOLEAN" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_BOOLEAN" value="4" enum="OpType"> A boolean type. </constant> - <constant name="OP_TYPE_TRANSFORM" value="4" enum="OpType"> + <constant name="OP_TYPE_TRANSFORM" value="5" enum="OpType"> A transform type. </constant> - <constant name="OP_TYPE_MAX" value="5" enum="OpType"> + <constant name="OP_TYPE_MAX" value="6" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeVec2Constant.xml b/doc/classes/VisualShaderNodeVec2Constant.xml new file mode 100644 index 0000000000..f897ab4091 --- /dev/null +++ b/doc/classes/VisualShaderNodeVec2Constant.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec2Constant" inherits="VisualShaderNodeConstant" version="4.0"> + <brief_description> + A [Vector2] constant to be used within the visual shader graph. + </brief_description> + <description> + A constant [Vector2], which can be used as an input node. + </description> + <tutorials> + </tutorials> + <members> + <member name="constant" type="Vector2" setter="set_constant" getter="get_constant" default="Vector2(0, 0)"> + A [Vector2] constant which represents the state of this node. + </member> + </members> +</class> diff --git a/doc/classes/VisualShaderNodeVec2Uniform.xml b/doc/classes/VisualShaderNodeVec2Uniform.xml new file mode 100644 index 0000000000..d5cf7e57c8 --- /dev/null +++ b/doc/classes/VisualShaderNodeVec2Uniform.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec2Uniform" inherits="VisualShaderNodeUniform" version="4.0"> + <brief_description> + A [Vector2] uniform to be used within the visual shader graph. + </brief_description> + <description> + Translated to [code]uniform vec2[/code] in the shader language. + </description> + <tutorials> + </tutorials> + <members> + <member name="default_value" type="Vector2" setter="set_default_value" getter="get_default_value" default="Vector2(0, 0)"> + A default value to be assigned within the shader. + </member> + <member name="default_value_enabled" type="bool" setter="set_default_value_enabled" getter="is_default_value_enabled" default="false"> + Enables usage of the [member default_value]. + </member> + </members> +</class> diff --git a/doc/classes/VisualShaderNodeVectorBase.xml b/doc/classes/VisualShaderNodeVectorBase.xml new file mode 100644 index 0000000000..8a560c1951 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorBase.xml @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorBase" inherits="VisualShaderNode" version="4.0"> + <brief_description> + A base type for the nodes using different vector types within the visual shader graph. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <members> + <member name="op_type" type="int" setter="set_op_type" getter="get_op_type" enum="VisualShaderNodeVectorBase.OpType" default="1"> + A base type. + </member> + </members> + <constants> + <constant name="OP_TYPE_VECTOR_2D" value="0" enum="OpType"> + A 2D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_3D" value="1" enum="OpType"> + A 3D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="2" enum="OpType"> + Represents the size of the [enum OpType] enum. + </constant> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeVectorCompose.xml b/doc/classes/VisualShaderNodeVectorCompose.xml index ebc30d03f4..b8caf154f9 100644 --- a/doc/classes/VisualShaderNodeVectorCompose.xml +++ b/doc/classes/VisualShaderNodeVectorCompose.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorCompose" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorCompose" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> Composes a [Vector3] from three scalars within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeVectorDecompose.xml b/doc/classes/VisualShaderNodeVectorDecompose.xml index 09986bf969..9ef9db0cfb 100644 --- a/doc/classes/VisualShaderNodeVectorDecompose.xml +++ b/doc/classes/VisualShaderNodeVectorDecompose.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorDecompose" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorDecompose" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> Decomposes a [Vector3] into three scalars within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml b/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml deleted file mode 100644 index e0c7c8618c..0000000000 --- a/doc/classes/VisualShaderNodeVectorDerivativeFunc.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorDerivativeFunc" inherits="VisualShaderNode" version="4.0"> - <brief_description> - Calculates a vector derivative within the visual shader graph. - </brief_description> - <description> - This node is only available in [code]Fragment[/code] and [code]Light[/code] visual shaders. - </description> - <tutorials> - </tutorials> - <members> - <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeVectorDerivativeFunc.Function" default="0"> - A derivative type. See [enum Function] for options. - </member> - </members> - <constants> - <constant name="FUNC_SUM" value="0" enum="Function"> - Sum of absolute derivative in [code]x[/code] and [code]y[/code]. - </constant> - <constant name="FUNC_X" value="1" enum="Function"> - Derivative in [code]x[/code] using local differencing. - </constant> - <constant name="FUNC_Y" value="2" enum="Function"> - Derivative in [code]y[/code] using local differencing. - </constant> - <constant name="FUNC_MAX" value="3" enum="Function"> - Represents the size of the [enum Function] enum. - </constant> - </constants> -</class> diff --git a/doc/classes/VisualShaderNodeVectorDistance.xml b/doc/classes/VisualShaderNodeVectorDistance.xml index 098787e583..c0d8ffe943 100644 --- a/doc/classes/VisualShaderNodeVectorDistance.xml +++ b/doc/classes/VisualShaderNodeVectorDistance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorDistance" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorDistance" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> Returns the distance between two points. To be used within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml index 27ae82e11b..17a6418b94 100644 --- a/doc/classes/VisualShaderNodeVectorFunc.xml +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorFunc" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorFunc" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> A vector function to be used within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeVectorLen.xml b/doc/classes/VisualShaderNodeVectorLen.xml index 165455e622..f1b6919bdc 100644 --- a/doc/classes/VisualShaderNodeVectorLen.xml +++ b/doc/classes/VisualShaderNodeVectorLen.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorLen" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorLen" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> Returns the length of a [Vector3] within the visual shader graph. </brief_description> diff --git a/doc/classes/VisualShaderNodeVectorOp.xml b/doc/classes/VisualShaderNodeVectorOp.xml index 5e8f0abda3..6a579abb9a 100644 --- a/doc/classes/VisualShaderNodeVectorOp.xml +++ b/doc/classes/VisualShaderNodeVectorOp.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualShaderNodeVectorOp" inherits="VisualShaderNode" version="4.0"> +<class name="VisualShaderNodeVectorOp" inherits="VisualShaderNodeVectorBase" version="4.0"> <brief_description> A vector operator to be used within the visual shader graph. </brief_description> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 3bb6603646..ab8f51ced5 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -398,6 +398,11 @@ Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project. Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. </constant> + <constant name="MODE_EXCLUSIVE_FULLSCREEN" value="4" enum="Mode"> + Exclusive fullscreen window mode. This mode is implemented on Windows only. On other platforms, it is equivalent to [constant MODE_FULLSCREEN]. + Only one window in exclusive fullscreen mode can be visible on a given screen at a time. If multiple windows are in exclusive fullscreen mode for the same screen, the last one being set to this mode takes precedence. + Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode. + </constant> <constant name="FLAG_RESIZE_DISABLED" value="0" enum="Flags"> The window's ability to be resized. </constant> diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index d2bb6aa59a..cd09f83335 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -9,46 +9,52 @@ <tutorials> </tutorials> <methods> - <method name="_commit_views" qualifiers="virtual"> + <method name="_end_frame" qualifiers="virtual"> <return type="void" /> - <argument index="0" name="render_target" type="RID" /> - <argument index="1" name="screen_rect" type="Rect2" /> <description> + Called if interface is active and queues have been submitted. </description> </method> <method name="_get_anchor_detection_is_enabled" qualifiers="virtual const"> <return type="bool" /> <description> + Return [code]true[/code] if anchor detection is enabled for this interface. </description> </method> <method name="_get_camera_feed_id" qualifiers="virtual const"> <return type="int" /> <description> + Returns the camera feed id for the [CameraFeed] registered with the [CameraServer] that should be presented as the background on an AR capable device (if applicable). </description> </method> <method name="_get_camera_transform" qualifiers="virtual"> <return type="Transform3D" /> <description> + Returns the [Transform3D] that positions the [XRCamera3D] in the world. </description> </method> <method name="_get_capabilities" qualifiers="virtual const"> <return type="int" /> <description> + Returns the capabilities of this interface. </description> </method> <method name="_get_name" qualifiers="virtual const"> <return type="StringName" /> <description> + Returns the name of this interface. </description> </method> <method name="_get_play_area" qualifiers="virtual const"> <return type="PackedVector3Array" /> <description> + Returns an [PackedVector3Array] that denotes the play areas boundaries (if applicable). </description> </method> <method name="_get_play_area_mode" qualifiers="virtual const"> <return type="int" /> <description> + Returns the [enum XRInterface.PlayAreaMode] that sets up our play area. </description> </method> <method name="_get_projection_for_view" qualifiers="virtual"> @@ -58,27 +64,32 @@ <argument index="2" name="z_near" type="float" /> <argument index="3" name="z_far" type="float" /> <description> + Returns the projection matrix for the given view as a [PackedFloat64Array]. </description> </method> <method name="_get_render_target_size" qualifiers="virtual"> <return type="Vector2" /> <description> + Returns the size of our render target for this interface, this overrides the size of the [Viewport] marked as the xr viewport. </description> </method> <method name="_get_suggested_pose_names" qualifiers="virtual const"> <return type="PackedStringArray" /> <argument index="0" name="tracker_name" type="StringName" /> <description> + Returns a [PackedStringArray] with pose names configured by this interface. Note that user configuration can override this list. </description> </method> <method name="_get_suggested_tracker_names" qualifiers="virtual const"> <return type="PackedStringArray" /> <description> + Returns a [PackedStringArray] with tracker names configured by this interface. Note that user configuration can override this list. </description> </method> <method name="_get_tracking_status" qualifiers="virtual const"> <return type="int" /> <description> + Returns a [enum XRInterface.TrackingStatus] specifying the current status of our tracking. </description> </method> <method name="_get_transform_for_view" qualifiers="virtual"> @@ -86,50 +97,80 @@ <argument index="0" name="view" type="int" /> <argument index="1" name="cam_transform" type="Transform3D" /> <description> + Returns a [Transform3D] for a given view. </description> </method> <method name="_get_view_count" qualifiers="virtual"> <return type="int" /> <description> + Returns the number of views this interface requires, 1 for mono, 2 for stereoscopic. </description> </method> <method name="_initialize" qualifiers="virtual"> <return type="bool" /> <description> + Initializes the interface, returns [code]true[/code] on success. </description> </method> <method name="_is_initialized" qualifiers="virtual const"> <return type="bool" /> <description> + Returns [code]true[/code] if this interface has been initialised. </description> </method> <method name="_notification" qualifiers="virtual"> <return type="void" /> <argument index="0" name="what" type="int" /> <description> + Informs the interface of an applicable system notification. + </description> + </method> + <method name="_post_draw_viewport" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="render_target" type="RID" /> + <argument index="1" name="screen_rect" type="Rect2" /> + <description> + Called after the XR [Viewport] draw logic has completed. + </description> + </method> + <method name="_pre_draw_viewport" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="render_target" type="RID" /> + <description> + Called if this is our primary [XRInterfaceExtension] before we start processing a [Viewport] for every active XR [Viewport], returns [code]true[/code] if that viewport should be rendered. An XR interface may return [code]false[/code] if the user has taken off their headset and we can pause rendering. + </description> + </method> + <method name="_pre_render" qualifiers="virtual"> + <return type="void" /> + <description> + Called if this [XRInterfaceExtension] is active before rendering starts, most XR interfaces will sync tracking at this point in time. </description> </method> <method name="_process" qualifiers="virtual"> <return type="void" /> <description> + Called if this [XRInterfaceExtension] is active before our physics and game process is called. most XR interfaces will update its [XRPositionalTracker]s at this point in time. </description> </method> <method name="_set_anchor_detection_is_enabled" qualifiers="virtual"> <return type="void" /> <argument index="0" name="enabled" type="bool" /> <description> + Enables anchor detection on this interface if supported. </description> </method> <method name="_set_play_area_mode" qualifiers="virtual const"> <return type="bool" /> <argument index="0" name="mode" type="int" /> <description> + Set the play area mode for this interface. </description> </method> <method name="_supports_play_area_mode" qualifiers="virtual const"> <return type="bool" /> <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> <description> + Returns [code]true[/code] if this interface supports this play area mode. </description> </method> <method name="_trigger_haptic_pulse" qualifiers="virtual"> @@ -141,11 +182,13 @@ <argument index="4" name="duration_sec" type="float" /> <argument index="5" name="delay_sec" type="float" /> <description> + Triggers a haptic pulse to be emitted on the specified tracker. </description> </method> <method name="_uninitialize" qualifiers="virtual"> <return type="void" /> <description> + Uninitialize the interface. </description> </method> <method name="add_blit"> @@ -169,6 +212,7 @@ <return type="RID" /> <argument index="0" name="render_target" type="RID" /> <description> + Returns a valid [RID] for a texture to which we should render the current frame if supported by the interface. </description> </method> </methods> diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 3a7fdea8d0..335ca4c35f 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -69,24 +69,6 @@ Returns a list of available interfaces the ID and name of each interface. </description> </method> - <method name="get_last_commit_usec"> - <return type="int" /> - <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 Time.get_ticks_usec]. - </description> - </method> - <method name="get_last_frame_usec"> - <return type="int" /> - <description> - Returns the duration (in μs) of the last frame. This is computed as the difference between [method get_last_commit_usec] and [method get_last_process_usec] when committing. - </description> - </method> - <method name="get_last_process_usec"> - <return type="int" /> - <description> - 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"> <return type="Transform3D" /> <description> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 49f2d2dd7f..243d19d94f 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -52,7 +52,7 @@ [codeblocks] [gdscript] var _can_shoot = true - onready var _cool_down = $CoolDownTimer + @onready var _cool_down = $CoolDownTimer func shoot(): if _can_shoot and Input.is_action_pressed("shoot"): diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index 9e18866ca3..68f3b66f43 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -438,7 +438,7 @@ def main(): # type: () -> None for path in args.path: # Cut off trailing slashes so os.path.basename doesn't choke. - if path.endswith(os.sep): + if path.endswith("/") or path.endswith("\\"): path = path[:-1] if os.path.basename(path) == "modules": |