diff options
Diffstat (limited to 'doc')
41 files changed, 1906 insertions, 333 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index fe0d7e4408..5d45947a19 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -2488,16 +2488,16 @@ <constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode"> Used with [method Node.rpc_config] to disable a method or property for all RPC calls, making it unavailable. Default for all methods. </constant> - <constant name="RPC_MODE_ANY" value="1" enum="RPCMode"> + <constant name="RPC_MODE_ANY_PEER" value="1" enum="RPCMode"> Used with [method Node.rpc_config] to set a method to be callable remotely by any peer. Analogous to the [code]@rpc(any)[/code] annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not. </constant> <constant name="RPC_MODE_AUTH" value="2" enum="RPCMode"> Used with [method Node.rpc_config] to set a method to be callable remotely only by the current multiplayer authority (which is the server by default). Analogous to the [code]@rpc(auth)[/code] annotation. See [method Node.set_multiplayer_authority]. </constant> <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> - Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_ORDERED]. Use for non-critical data, and always consider whether the order matters. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_UNRELIABLE_ORDERED]. Use for non-critical data, and always consider whether the order matters. </constant> - <constant name="TRANSFER_MODE_ORDERED" value="1" enum="TransferMode"> + <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [constant TRANSFER_MODE_RELIABLE]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index a5516636aa..84ed0de42d 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -250,7 +250,8 @@ The strength of the normal map's effect. </member> <member name="normal_texture" type="Texture2D" setter="set_texture" getter="get_texture"> - Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh]. + Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh]. + [b]Note:[/b] The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with [SurfaceTool], you can use [method SurfaceTool.generate_normals] and [method SurfaceTool.generate_tangents] to automatically generate normals and tangents respectively. [b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines. </member> <member name="orm_texture" type="Texture2D" setter="set_texture" getter="get_texture"> diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index cd17a31e23..06e2f83f05 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -26,7 +26,7 @@ <method name="get_camera_transform" qualifiers="const"> <return type="Transform3D" /> <description> - Returns the transform of the camera plus the vertical ([member v_offset]) and horizontal ([member h_offset]) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as [ClippedCamera3D] and [XRCamera3D]. + Returns the transform of the camera plus the vertical ([member v_offset]) and horizontal ([member h_offset]) offsets; and any other adjustments made to the position and orientation of the camera by subclassed cameras such as [XRCamera3D]. </description> </method> <method name="get_cull_mask_value" qualifiers="const"> @@ -42,6 +42,12 @@ Returns the camera's frustum planes in world space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset]. </description> </method> + <method name="get_pyramid_shape_rid"> + <return type="RID" /> + <description> + Returns the RID of a pyramid shape encompassing the camera's view frustum, ignoring the camera's near plane. The tip of the pyramid represents the position of the camera. + </description> + </method> <method name="is_position_behind" qualifiers="const"> <return type="bool" /> <argument index="0" name="world_point" type="Vector3" /> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 501f89fa0d..738594ea5d 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -150,7 +150,7 @@ <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="8" name="outline_size" type="int" default="0" /> <argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> - <argument index="10" name="flags" type="int" default="51" /> + <argument index="10" name="flags" type="int" default="99" /> <description> Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. </description> diff --git a/doc/classes/ClippedCamera3D.xml b/doc/classes/ClippedCamera3D.xml deleted file mode 100644 index 1a0d3499cd..0000000000 --- a/doc/classes/ClippedCamera3D.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="ClippedCamera3D" inherits="Camera3D" version="4.0"> - <brief_description> - A [Camera3D] that includes collision. - </brief_description> - <description> - This node extends [Camera3D] to add collisions with [Area3D] and/or [PhysicsBody3D] nodes. The camera cannot move through colliding objects. - </description> - <tutorials> - </tutorials> - <methods> - <method name="add_exception"> - <return type="void" /> - <argument index="0" name="node" type="Object" /> - <description> - Adds a collision exception so the camera does not collide with the specified node. - </description> - </method> - <method name="add_exception_rid"> - <return type="void" /> - <argument index="0" name="rid" type="RID" /> - <description> - Adds a collision exception so the camera does not collide with the specified [RID]. - </description> - </method> - <method name="clear_exceptions"> - <return type="void" /> - <description> - Removes all collision exceptions. - </description> - </method> - <method name="get_clip_offset" qualifiers="const"> - <return type="float" /> - <description> - Returns the distance the camera has been offset due to a collision. - </description> - </method> - <method name="get_collision_mask_value" qualifiers="const"> - <return type="bool" /> - <argument index="0" name="layer_number" type="int" /> - <description> - Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32. - </description> - </method> - <method name="remove_exception"> - <return type="void" /> - <argument index="0" name="node" type="Object" /> - <description> - Removes a collision exception with the specified node. - </description> - </method> - <method name="remove_exception_rid"> - <return type="void" /> - <argument index="0" name="rid" type="RID" /> - <description> - Removes a collision exception with the specified [RID]. - </description> - </method> - <method name="set_collision_mask_value"> - <return type="void" /> - <argument index="0" name="layer_number" type="int" /> - <argument index="1" name="value" type="bool" /> - <description> - Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32. - </description> - </method> - </methods> - <members> - <member name="clip_to_areas" type="bool" setter="set_clip_to_areas" getter="is_clip_to_areas_enabled" default="false"> - If [code]true[/code], the camera stops on contact with [Area3D]s. - </member> - <member name="clip_to_bodies" type="bool" setter="set_clip_to_bodies" getter="is_clip_to_bodies_enabled" default="true"> - If [code]true[/code], the camera stops on contact with [PhysicsBody3D]s. - </member> - <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> - The camera's collision mask. Only objects in at least one collision layer matching the mask will be detected. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. - </member> - <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.0"> - The camera's collision margin. The camera can't get closer than this distance to a colliding object. - </member> - <member name="process_callback" type="int" setter="set_process_callback" getter="get_process_callback" enum="ClippedCamera3D.ClipProcessCallback" default="0"> - The camera's process callback. See [enum ClipProcessCallback]. - </member> - </members> - <constants> - <constant name="CLIP_PROCESS_PHYSICS" value="0" enum="ClipProcessCallback"> - The camera updates with the [code]_physics_process[/code] callback. - </constant> - <constant name="CLIP_PROCESS_IDLE" value="1" enum="ClipProcessCallback"> - The camera updates with the [code]_process[/code] callback. - </constant> - </constants> -</class> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index c9a2de66a8..6ec754d3f9 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -458,6 +458,27 @@ See [method get_theme_color] for details. </description> </method> + <method name="get_theme_default_base_scale" qualifiers="const"> + <return type="float" /> + <description> + Returns the default base scale value from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_base_scale] value. + See [method get_theme_color] for details. + </description> + </method> + <method name="get_theme_default_font" qualifiers="const"> + <return type="Font" /> + <description> + Returns the default font from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_font] value. + See [method get_theme_color] for details. + </description> + </method> + <method name="get_theme_default_font_size" qualifiers="const"> + <return type="int" /> + <description> + Returns the default font size value from the first matching [Theme] in the tree if that [Theme] has a valid [member Theme.default_font_size] value. + See [method get_theme_color] for details. + </description> + </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> <argument index="0" name="name" type="StringName" /> @@ -742,10 +763,10 @@ </method> <method name="set_drag_forwarding"> <return type="void" /> - <argument index="0" name="target" type="Control" /> + <argument index="0" name="target" type="Node" /> <description> - Forwards the handling of this control's drag and drop to [code]target[/code] control. - Forwarding can be implemented in the target control similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: + Forwards the handling of this control's drag and drop to [code]target[/code] node. + Forwarding can be implemented in the target node similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: 1. The function name must be suffixed with [b]_fw[/b] 2. The function must take an extra argument that is the control doing the forwarding [codeblocks] @@ -1023,7 +1044,7 @@ <member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale" default="Vector2(1, 1)"> The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. The Control's [member hint_tooltip] will also scale according to this value. [b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually. - [b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using [code]yield(get_tree(), "idle_frame")[/code] then set its [member rect_scale] property. + [b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using [code]yield(get_tree(), "process_frame")[/code] then set its [member rect_scale] property. </member> <member name="rect_size" type="Vector2" setter="_set_size" getter="get_size" default="Vector2(0, 0)"> The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 4f495eaec9..7eff8db59c 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -276,6 +276,14 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> + <method name="keyboard_get_keycode_from_physical" qualifiers="const"> + <return type="int" enum="Key" /> + <argument index="0" name="keycode" type="int" enum="Key" /> + <description> + Converts a physical (US QWERTY) [code]keycode[/code] to one in the active keyboard layout. + [b]Note:[/b] This method is implemented on Linux, macOS and Windows. + </description> + </method> <method name="keyboard_get_layout_count" qualifiers="const"> <return type="int" /> <description> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index e8ff0f60ec..39881e9eb7 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -103,7 +103,7 @@ <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> <argument index="8" name="outline_size" type="int" default="0" /> <argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" /> - <argument index="10" name="flags" type="int" default="51" /> + <argument index="10" name="flags" type="int" default="99" /> <description> Breaks [code]text[/code] to the lines using rules specified by [code]flags[/code] and draws it into a canvas item using the font, at a given position, with [code]modulate[/code] color, optionally clipping the width and aligning horizontally. [code]position[/code] specifies the baseline of the first line, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_multiline_string]. @@ -185,7 +185,7 @@ <argument index="0" name="text" type="String" /> <argument index="1" name="width" type="float" default="-1" /> <argument index="2" name="size" type="int" default="-1" /> - <argument index="3" name="flags" type="int" default="48" /> + <argument index="3" name="flags" type="int" default="96" /> <description> Returns the size of a bounding box of a string broken into the lines, taking kerning and advance into account. See also [method draw_multiline_string]. diff --git a/doc/classes/EditorSceneImporterMesh.xml b/doc/classes/ImporterMesh.xml index 5d57a76d5f..ab344f908c 100644 --- a/doc/classes/EditorSceneImporterMesh.xml +++ b/doc/classes/ImporterMesh.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporterMesh" inherits="Resource" version="4.0"> +<class name="ImporterMesh" inherits="Resource" version="4.0"> <brief_description> A [Resource] that contains vertex array-based geometry during the import process. </brief_description> <description> - EditorSceneImporterMesh is a type of [Resource] analogous to [ArrayMesh]. It contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. + ImporterMesh is a type of [Resource] analogous to [ArrayMesh]. It contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. - Unlike its runtime counterpart, [EditorSceneImporterMesh] contains mesh data before various import steps, such as lod and shadow mesh generation, have taken place. Modify surface data by calling [method clear], followed by [method add_surface] for each surface. + Unlike its runtime counterpart, [ImporterMesh] contains mesh data before various import steps, such as lod and shadow mesh generation, have taken place. Modify surface data by calling [method clear], followed by [method add_surface] for each surface. </description> <tutorials> </tutorials> @@ -37,7 +37,7 @@ <method name="clear"> <return type="void" /> <description> - Removes all surfaces and blend shapes from this [EditorSceneImporterMesh]. + Removes all surfaces and blend shapes from this [ImporterMesh]. </description> </method> <method name="get_blend_shape_count" qualifiers="const"> @@ -69,7 +69,7 @@ <return type="ArrayMesh" /> <argument index="0" name="base_mesh" type="ArrayMesh" default="null" /> <description> - Returns the mesh data represented by this [EditorSceneImporterMesh] as a usable [ArrayMesh]. + Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh]. This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called. If not yet cached and [code]base_mesh[/code] is provided, [code]base_mesh[/code] will be used and mutated. </description> diff --git a/doc/classes/EditorSceneImporterMeshNode3D.xml b/doc/classes/ImporterMeshInstance3D.xml index 848448110e..6d572f543b 100644 --- a/doc/classes/EditorSceneImporterMeshNode3D.xml +++ b/doc/classes/ImporterMeshInstance3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSceneImporterMeshNode3D" inherits="Node3D" version="4.0"> +<class name="ImporterMeshInstance3D" inherits="Node3D" version="4.0"> <brief_description> </brief_description> <description> @@ -7,7 +7,7 @@ <tutorials> </tutorials> <members> - <member name="mesh" type="EditorSceneImporterMesh" setter="set_mesh" getter="get_mesh"> + <member name="mesh" type="ImporterMesh" setter="set_mesh" getter="get_mesh"> </member> <member name="skeleton_path" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath("")"> </member> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml index 29fc4700fd..23b01a0fc9 100644 --- a/doc/classes/KinematicCollision2D.xml +++ b/doc/classes/KinematicCollision2D.xml @@ -14,43 +14,74 @@ <return type="float" /> <argument index="0" name="up_direction" type="Vector2" default="Vector2(0, -1)" /> <description> - The collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's attached [Object]. + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the unique instance ID of the colliding body's attached [Object]. See [method Object.get_instance_id]. + </description> + </method> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID" /> + <description> + Returns the colliding body's [RID] used by the [PhysicsServer2D]. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's shape. + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int" /> + <description> + Returns the colliding body's shape index. See [CollisionObject2D]. + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's velocity. + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object" /> + <description> + Returns the moving object's colliding shape. + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's shape's normal at the point of collision. + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the point of collision in global coordinates. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_collider"> - The colliding body. - </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> - The colliding body's unique instance ID. See [method Object.get_instance_id]. - </member> - <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> - The colliding body's [RID] used by the [PhysicsServer2D]. - </member> - <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> - The colliding body's shape. - </member> - <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index" default="0"> - The colliding shape's index. See [CollisionObject2D]. - </member> - <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)"> - The colliding object's velocity. - </member> - <member name="local_shape" type="Object" setter="" getter="get_local_shape"> - The moving object's colliding shape. - </member> - <member name="normal" type="Vector2" setter="" getter="get_normal" default="Vector2(0, 0)"> - The colliding body's shape's normal at the point of collision. - </member> - <member name="position" type="Vector2" setter="" getter="get_position" default="Vector2(0, 0)"> - The point of collision, in global coordinates. - </member> - <member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)"> - The moving object's remaining movement vector. - </member> - <member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)"> - The distance the moving object traveled before collision. - </member> - </members> </class> diff --git a/doc/classes/KinematicCollision3D.xml b/doc/classes/KinematicCollision3D.xml index 3db6fe019b..372113b281 100644 --- a/doc/classes/KinematicCollision3D.xml +++ b/doc/classes/KinematicCollision3D.xml @@ -15,108 +15,89 @@ <argument index="0" name="collision_index" type="int" default="0" /> <argument index="1" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> <description> - The collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. + Returns the collision angle according to [code]up_direction[/code], which is [code]Vector3.UP[/code] by default. This value is always positive. </description> </method> <method name="get_collider" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider by index (the latest by default). + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider ID by index (the latest by default). + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider RID by index (the latest by default). + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider shape by index (the latest by default). + Returns the colliding body's shape given a collision index (the deepest collision by default). </description> </method> <method name="get_collider_shape_index" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider shape index by index (the latest by default). + Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider velocity by index (the latest by default). + Returns the colliding body's velocity given a collision index (the deepest collision by default). + </description> + </method> + <method name="get_collision_count" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of detected collisions. </description> </method> <method name="get_local_shape" qualifiers="const"> <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider velocity by index (the latest by default). + Returns the moving object's colliding shape given a collision index (the deepest collision by default). </description> </method> <method name="get_normal" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider normal by index (the latest by default). + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). </description> </method> <method name="get_position" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> - Returns the collider collision point by index (the latest by default). + Returns the point of collision in global coordinates given a collision index (the deepest collision by default). + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_best_collider"> - The colliding body. - </member> - <member name="collider_id" type="int" setter="" getter="get_best_collider_id" default="0"> - The colliding body's unique instance ID. See [method Object.get_instance_id]. - </member> - <member name="collider_rid" type="RID" setter="" getter="get_best_collider_rid"> - The colliding body's [RID] used by the [PhysicsServer3D]. - </member> - <member name="collider_shape" type="Object" setter="" getter="get_best_collider_shape"> - The colliding body's shape. - </member> - <member name="collider_shape_index" type="int" setter="" getter="get_best_collider_shape_index" default="0"> - The colliding shape's index. See [CollisionObject3D]. - </member> - <member name="collider_velocity" type="Vector3" setter="" getter="get_best_collider_velocity" default="Vector3(0, 0, 0)"> - The colliding object's velocity. - </member> - <member name="collision_count" type="int" setter="" getter="get_collision_count" default="0"> - </member> - <member name="local_shape" type="Object" setter="" getter="get_best_local_shape"> - The moving object's colliding shape. - </member> - <member name="normal" type="Vector3" setter="" getter="get_best_normal" default="Vector3(0, 0, 0)"> - The colliding body's shape's normal at the point of collision. - </member> - <member name="position" type="Vector3" setter="" getter="get_best_position" default="Vector3(0, 0, 0)"> - The point of collision, in global coordinates. - </member> - <member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3(0, 0, 0)"> - The moving object's remaining movement vector. - </member> - <member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3(0, 0, 0)"> - The distance the moving object traveled before collision. - </member> - </members> </class> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index a3e98228c6..f77b69b1f9 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -20,11 +20,12 @@ <members> <member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass"> Sets the [Material] to be used for the next pass. This renders the object again using a different material. - [b]Note:[/b] only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". + [b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". </member> <member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority" default="0"> Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. - [b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). + [b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". + [b]Note:[/b] This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). </member> </members> <constants> diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 15517f7c2f..67d3161aba 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -58,7 +58,7 @@ </member> <member name="transfer_channel" type="int" setter="set_transfer_channel" getter="get_transfer_channel" default="0"> The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send [b]different and independent[/b] state updates is a common way to optimize network usage and decrease latency in fast-paced games. - [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. + [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_UNRELIABLE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. </member> <member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="TransferMode" default="2"> The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 9d0d185c42..656fa61af7 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -246,7 +246,7 @@ <method name="get_name" qualifiers="const"> <return type="String" /> <description> - Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"OSX"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. + Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"macOS"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. </description> </method> <method name="get_process_id" qualifiers="const"> diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 8e94254a1f..39733baf40 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -43,6 +43,15 @@ Appends a [PackedByteArray] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="int" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="compress" qualifiers="const"> <return type="PackedByteArray" /> <argument index="0" name="compression_mode" type="int" default="0" /> diff --git a/doc/classes/PackedColorArray.xml b/doc/classes/PackedColorArray.xml index 4bccdcd939..00e670646d 100644 --- a/doc/classes/PackedColorArray.xml +++ b/doc/classes/PackedColorArray.xml @@ -43,6 +43,15 @@ Appends a [PackedColorArray] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="Color" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedColorArray" /> <description> diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index 51e14ea3d4..2ee2ac44df 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -44,6 +44,15 @@ Appends a [PackedFloat32Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="float" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedFloat32Array" /> <description> diff --git a/doc/classes/PackedFloat64Array.xml b/doc/classes/PackedFloat64Array.xml index 25c9c025f7..7414bc72fc 100644 --- a/doc/classes/PackedFloat64Array.xml +++ b/doc/classes/PackedFloat64Array.xml @@ -44,6 +44,15 @@ Appends a [PackedFloat64Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="float" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedFloat64Array" /> <description> diff --git a/doc/classes/PackedInt32Array.xml b/doc/classes/PackedInt32Array.xml index 1a61ce0ead..8ecf4a70ae 100644 --- a/doc/classes/PackedInt32Array.xml +++ b/doc/classes/PackedInt32Array.xml @@ -44,6 +44,15 @@ Appends a [PackedInt32Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="int" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedInt32Array" /> <description> diff --git a/doc/classes/PackedInt64Array.xml b/doc/classes/PackedInt64Array.xml index 06f7900237..b82ce79009 100644 --- a/doc/classes/PackedInt64Array.xml +++ b/doc/classes/PackedInt64Array.xml @@ -44,6 +44,15 @@ Appends a [PackedInt64Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="int" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedInt64Array" /> <description> diff --git a/doc/classes/PackedStringArray.xml b/doc/classes/PackedStringArray.xml index 763ed0cc55..353bbfb827 100644 --- a/doc/classes/PackedStringArray.xml +++ b/doc/classes/PackedStringArray.xml @@ -44,6 +44,15 @@ Appends a [PackedStringArray] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="String" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedStringArray" /> <description> diff --git a/doc/classes/PackedVector2Array.xml b/doc/classes/PackedVector2Array.xml index 3f0797bb59..7b7df221e7 100644 --- a/doc/classes/PackedVector2Array.xml +++ b/doc/classes/PackedVector2Array.xml @@ -44,6 +44,15 @@ Appends a [PackedVector2Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="Vector2" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedVector2Array" /> <description> diff --git a/doc/classes/PackedVector3Array.xml b/doc/classes/PackedVector3Array.xml index 6b950cad61..efbf2169fd 100644 --- a/doc/classes/PackedVector3Array.xml +++ b/doc/classes/PackedVector3Array.xml @@ -43,6 +43,15 @@ Appends a [PackedVector3Array] at the end of this array. </description> </method> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="Vector3" /> + <argument index="1" name="before" type="bool" default="true" /> + <description> + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> <method name="duplicate"> <return type="PackedVector3Array" /> <description> diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index b5b6a7ea58..d55feff829 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -584,14 +584,10 @@ <method name="body_test_motion"> <return type="bool" /> <argument index="0" name="body" type="RID" /> - <argument index="1" name="from" type="Transform2D" /> - <argument index="2" name="motion" type="Vector2" /> - <argument index="3" name="margin" type="float" default="0.08" /> - <argument index="4" name="result" type="PhysicsTestMotionResult2D" default="null" /> - <argument index="5" name="collide_separation_ray" type="bool" default="false" /> - <argument index="6" name="exclude" type="Array" default="[]" /> - <description> - Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [PhysicsTestMotionResult2D] can be passed to return additional information in. + <argument index="1" name="parameters" type="PhysicsTestMotionParameters2D" /> + <argument index="2" name="result" type="PhysicsTestMotionResult2D" default="null" /> + <description> + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters2D] is passed to set motion parameters. [PhysicsTestMotionResult2D] can be passed to return additional information. </description> </method> <method name="capsule_shape_create"> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 1d1ca54dbb..0e32d1defa 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -577,15 +577,10 @@ <method name="body_test_motion"> <return type="bool" /> <argument index="0" name="body" type="RID" /> - <argument index="1" name="from" type="Transform3D" /> - <argument index="2" name="motion" type="Vector3" /> - <argument index="3" name="margin" type="float" default="0.001" /> - <argument index="4" name="result" type="PhysicsTestMotionResult3D" default="null" /> - <argument index="5" name="collide_separation_ray" type="bool" default="false" /> - <argument index="6" name="exclude" type="Array" default="[]" /> - <argument index="7" name="max_collisions" type="int" default="1" /> - <description> - Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [PhysicsTestMotionResult3D] can be passed to return additional information in. + <argument index="1" name="parameters" type="PhysicsTestMotionParameters3D" /> + <argument index="2" name="result" type="PhysicsTestMotionResult3D" default="null" /> + <description> + Returns [code]true[/code] if a collision would result from moving along a motion vector from a given point in space. [PhysicsTestMotionParameters3D] is passed to set motion parameters. [PhysicsTestMotionResult3D] can be passed to return additional information. </description> </method> <method name="box_shape_create"> diff --git a/doc/classes/PhysicsTestMotionParameters2D.xml b/doc/classes/PhysicsTestMotionParameters2D.xml new file mode 100644 index 0000000000..7cea848039 --- /dev/null +++ b/doc/classes/PhysicsTestMotionParameters2D.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsTestMotionParameters2D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 2D body motion test. + </brief_description> + <description> + This class contains parameters used in [method PhysicsServer2D.body_test_motion]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false"> + If set to [code]true[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. + If set to [code]false[/code], shapes of type [constant PhysicsServer2D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes. + </member> + <member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]"> + Optional array of body [RID] to exclude from collision. + </member> + <member name="from" type="Transform2D" setter="set_from" getter="get_from" default="Transform2D(1, 0, 0, 1, 0, 0)"> + Transform in global space where the motion should start. Usually set to [member Node2D.global_transform] for the current body's transform. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.08"> + Increases the size of the shapes involved in the collision detection. + </member> + <member name="motion" type="Vector2" setter="set_motion" getter="get_motion" default="Vector2(0, 0)"> + Motion vector to define the length and direction of the motion to test. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsTestMotionParameters3D.xml b/doc/classes/PhysicsTestMotionParameters3D.xml new file mode 100644 index 0000000000..07abbb1cb1 --- /dev/null +++ b/doc/classes/PhysicsTestMotionParameters3D.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsTestMotionParameters3D" inherits="RefCounted" version="4.0"> + <brief_description> + Parameters to be sent to a 3D body motion test. + </brief_description> + <description> + This class contains parameters used in [method PhysicsServer3D.body_test_motion]. + </description> + <tutorials> + </tutorials> + <members> + <member name="collide_separation_ray" type="bool" setter="set_collide_separation_ray_enabled" getter="is_collide_separation_ray_enabled" default="false"> + If set to [code]true[/code], shapes of type [constant PhysicsServer3D.SHAPE_SEPARATION_RAY] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground. + If set to [code]false[/code], shapes of type [constant PhysicsServer3D.SHAPE_SEPARATION_RAY] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes. + </member> + <member name="exclude_bodies" type="Array" setter="set_exclude_bodies" getter="get_exclude_bodies" default="[]"> + Optional array of body [RID] to exclude from collision. + </member> + <member name="from" type="Transform3D" setter="set_from" getter="get_from" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)"> + Transform in global space where the motion should start. Usually set to [member Node3D.global_transform] for the current body's transform. + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.001"> + Increases the size of the shapes involved in the collision detection. + </member> + <member name="max_collisions" type="int" setter="set_max_collisions" getter="get_max_collisions" default="1"> + Maximum number of returned collisions, between [code]1[/code] and [code]32[/code]. Always returns the deepest detected collisions. + </member> + <member name="motion" type="Vector3" setter="set_motion" getter="get_motion" default="Vector3(0, 0, 0)"> + Motion vector to define the length and direction of the motion to test. + </member> + </members> +</class> diff --git a/doc/classes/PhysicsTestMotionResult2D.xml b/doc/classes/PhysicsTestMotionResult2D.xml index 8d594af673..355365cf25 100644 --- a/doc/classes/PhysicsTestMotionResult2D.xml +++ b/doc/classes/PhysicsTestMotionResult2D.xml @@ -1,35 +1,91 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsTestMotionResult2D" inherits="RefCounted" version="4.0"> <brief_description> + Result from a 2D body motion test. </brief_description> <description> + This class contains the motion and collision result from [method PhysicsServer2D.body_test_motion]. </description> <tutorials> </tutorials> - <members> - <member name="collider" type="Object" setter="" getter="get_collider"> - </member> - <member name="collider_id" type="int" setter="" getter="get_collider_id" default="0"> - </member> - <member name="collider_rid" type="RID" setter="" getter="get_collider_rid"> - </member> - <member name="collider_shape" type="int" setter="" getter="get_collider_shape" default="0"> - </member> - <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity" default="Vector2(0, 0)"> - </member> - <member name="collision_depth" type="float" setter="" getter="get_collision_depth" default="0.0"> - </member> - <member name="collision_normal" type="Vector2" setter="" getter="get_collision_normal" default="Vector2(0, 0)"> - </member> - <member name="collision_point" type="Vector2" setter="" getter="get_collision_point" default="Vector2(0, 0)"> - </member> - <member name="collision_safe_fraction" type="float" setter="" getter="get_collision_safe_fraction" default="0.0"> - </member> - <member name="collision_unsafe_fraction" type="float" setter="" getter="get_collision_unsafe_fraction" default="0.0"> - </member> - <member name="remainder" type="Vector2" setter="" getter="get_remainder" default="Vector2(0, 0)"> - </member> - <member name="travel" type="Vector2" setter="" getter="get_travel" default="Vector2(0, 0)"> - </member> - </members> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object" /> + <description> + Returns the colliding body's attached [Object], if a collision occured. + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int" /> + <description> + Returns the unique instance ID of the colliding body's attached [Object], if a collision occured. See [method Object.get_instance_id]. + </description> + </method> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID" /> + <description> + Returns the colliding body's [RID] used by the [PhysicsServer2D], if a collision occured. + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int" /> + <description> + Returns the colliding body's shape index, if a collision occured. See [CollisionObject2D]. + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's velocity, if a collision occured. + </description> + </method> + <method name="get_collision_depth" qualifiers="const"> + <return type="float" /> + <description> + Returns the length of overlap along the collision normal, if a collision occured. + </description> + </method> + <method name="get_collision_local_shape" qualifiers="const"> + <return type="int" /> + <description> + Returns the moving object's colliding shape, if a collision occured. + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the colliding body's shape's normal at the point of collision, if a collision occured. + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the point of collision in global coordinates, if a collision occured. + </description> + </method> + <method name="get_collision_safe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the maximum fraction of the motion that can occur without a collision, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_collision_unsafe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the minimum fraction of the motion needed to collide, if a collision occured, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the moving object's travel before collision. + </description> + </method> + </methods> </class> diff --git a/doc/classes/PhysicsTestMotionResult3D.xml b/doc/classes/PhysicsTestMotionResult3D.xml index 8aa087e99a..282c140568 100644 --- a/doc/classes/PhysicsTestMotionResult3D.xml +++ b/doc/classes/PhysicsTestMotionResult3D.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsTestMotionResult3D" inherits="RefCounted" version="4.0"> <brief_description> + Result from a 3D body motion test. </brief_description> <description> + This class contains the motion and collision result from [method PhysicsServer3D.body_test_motion]. </description> <tutorials> </tutorials> @@ -11,77 +13,94 @@ <return type="Object" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collider_id" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default), if a collision occured. See [method Object.get_instance_id]. </description> </method> <method name="get_collider_rid" qualifiers="const"> <return type="RID" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occured. See [CollisionObject3D]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_count" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of detected collisions. </description> </method> <method name="get_collision_depth" qualifiers="const"> <return type="float" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_local_shape" qualifiers="const"> + <return type="int" /> + <argument index="0" name="collision_index" type="int" default="0" /> + <description> + Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occured. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector3" /> <argument index="0" name="collision_index" type="int" default="0" /> <description> + Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occured. + </description> + </method> + <method name="get_collision_safe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the maximum fraction of the motion that can occur without a collision, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_collision_unsafe_fraction" qualifiers="const"> + <return type="float" /> + <description> + Returns the minimum fraction of the motion needed to collide, if a collision occured, between [code]0[/code] and [code]1[/code]. + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's remaining movement vector. + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3" /> + <description> + Returns the moving object's travel before collision. </description> </method> </methods> - <members> - <member name="collider" type="Object" setter="" getter="get_best_collider"> - </member> - <member name="collider_id" type="int" setter="" getter="get_best_collider_id" default="0"> - </member> - <member name="collider_rid" type="RID" setter="" getter="get_best_collider_rid"> - </member> - <member name="collider_shape" type="int" setter="" getter="get_best_collider_shape" default="0"> - </member> - <member name="collider_velocity" type="Vector3" setter="" getter="get_best_collider_velocity" default="Vector3(0, 0, 0)"> - </member> - <member name="collision_count" type="int" setter="" getter="get_collision_count" default="0"> - </member> - <member name="collision_depth" type="float" setter="" getter="get_best_collision_depth" default="0.0"> - </member> - <member name="collision_normal" type="Vector3" setter="" getter="get_best_collision_normal" default="Vector3(0, 0, 0)"> - </member> - <member name="collision_point" type="Vector3" setter="" getter="get_best_collision_point" default="Vector3(0, 0, 0)"> - </member> - <member name="remainder" type="Vector3" setter="" getter="get_remainder" default="Vector3(0, 0, 0)"> - </member> - <member name="safe_fraction" type="float" setter="" getter="get_safe_fraction" default="0.0"> - </member> - <member name="travel" type="Vector3" setter="" getter="get_travel" default="Vector3(0, 0, 0)"> - </member> - <member name="unsafe_fraction" type="float" setter="" getter="get_unsafe_fraction" default="0.0"> - </member> - </members> </class> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index b5be04fb01..d40ad80d68 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -185,6 +185,18 @@ <description> </description> </method> + <method name="canvas_item_add_msdf_texture_rect_region"> + <return type="void" /> + <argument index="0" name="item" type="RID" /> + <argument index="1" name="rect" type="Rect2" /> + <argument index="2" name="texture" type="RID" /> + <argument index="3" name="src_rect" type="Rect2" /> + <argument index="4" name="modulate" type="Color" default="Color(1, 1, 1, 1)" /> + <argument index="5" name="outline_size" type="int" default="0" /> + <argument index="6" name="px_range" type="float" default="1.0" /> + <description> + </description> + </method> <method name="canvas_item_add_multimesh"> <return type="void" /> <argument index="0" name="item" type="RID" /> diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 9fbe91f38b..f95d069069 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -4,8 +4,8 @@ A shortcut for binding input. </brief_description> <description> - A shortcut for binding input. Shortcuts are commonly used for interacting with a [Control] element from an [InputEvent] (also known as hotkeys). + One shortcut can contain multiple [InputEvent]'s, allowing the possibility of triggering one action with multiple different inputs. </description> <tutorials> </tutorials> @@ -13,27 +13,27 @@ <method name="get_as_text" qualifiers="const"> <return type="String" /> <description> - Returns the shortcut's [InputEvent] as a [String]. + Returns the shortcut's first valid [InputEvent] as a [String]. </description> </method> <method name="has_valid_event" qualifiers="const"> <return type="bool" /> <description> - Returns whether the shortcut has a valid [member event] assigned to it. + Returns whether [member events] contains an [InputEvent] which is valid. </description> </method> <method name="matches_event" qualifiers="const"> <return type="bool" /> <argument index="0" name="event" type="InputEvent" /> <description> - Returns whether the shortcut's [member event] matches [code]event[/code]. + Returns whether any [InputEvent] in [member events] equals [code]event[/code]. </description> </method> </methods> <members> - <member name="event" type="InputEvent" setter="set_event" getter="get_event"> - The shortcut's [InputEvent]. - Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction]. + <member name="events" type="Array" setter="set_events" getter="get_events" default="[]"> + The shortcut's [InputEvent] array. + Generally the [InputEvent] used is an [InputEventKey], though it can be any [InputEvent], including an [InputEventAction]. </member> </members> </class> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index e5b03eb4d4..6a4ec08ec3 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -129,14 +129,14 @@ <return type="void" /> <argument index="0" name="flip" type="bool" default="false" /> <description> - Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. + Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. For correct display of normal-mapped surfaces, you will also have to generate tangents using [method generate_tangents]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. </description> </method> <method name="generate_tangents"> <return type="void" /> <description> - Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. + Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already (see [method generate_normals]). </description> </method> <method name="get_custom_format" qualifiers="const"> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 3ee3feb365..ded4f0b32f 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -217,18 +217,12 @@ </member> </members> <signals> - <signal name="reposition_active_tab_request"> + <signal name="active_tab_rearranged"> <argument index="0" name="idx_to" type="int" /> <description> Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. </description> </signal> - <signal name="right_button_pressed"> - <argument index="0" name="tab" type="int" /> - <description> - Emitted when a tab is right-clicked. - </description> - </signal> <signal name="tab_changed"> <argument index="0" name="tab" type="int" /> <description> @@ -253,6 +247,12 @@ Emitted when a tab is hovered by the mouse. </description> </signal> + <signal name="tab_rmb_clicked"> + <argument index="0" name="tab" type="int" /> + <description> + Emitted when a tab is right-clicked. + </description> + </signal> </signals> <constants> <constant name="ALIGN_LEFT" value="0" enum="TabAlign"> @@ -281,15 +281,15 @@ </constant> </constants> <theme_items> - <theme_item name="button" data_type="style" type="StyleBox"> + <theme_item name="close" data_type="icon" type="Texture2D"> + The icon for the close button (see [member tab_close_display_policy]). + </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> - <theme_item name="button_pressed" data_type="style" type="StyleBox"> + <theme_item name="close_bg_pressed" data_type="style" type="StyleBox"> Background of the close button when it's being pressed. </theme_item> - <theme_item name="close" data_type="icon" type="Texture2D"> - The icon for the close button (see [member tab_close_display_policy]). - </theme_item> <theme_item name="decrement" data_type="icon" type="Texture2D"> Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. </theme_item> @@ -315,7 +315,7 @@ Font color of the other, unselected tabs. </theme_item> <theme_item name="hseparation" data_type="constant" type="int" default="4"> - The horizontal separation between the tabs. + The horizontal separation between the elements inside tabs. </theme_item> <theme_item name="increment" 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. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index aa35acdbd2..e06dfee698 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -281,7 +281,7 @@ <member name="direction" type="int" setter="set_direction" getter="get_direction" enum="TextServer.Direction" default="0"> Text writing direction. </member> - <member name="flags" type="int" setter="set_flags" getter="get_flags" default="51"> + <member name="flags" type="int" setter="set_flags" getter="get_flags" default="99"> Line breaking and alignment rules. For more info see [TextServer]. </member> <member name="max_lines_visible" type="int" setter="set_max_lines_visible" getter="get_max_lines_visible" default="-1"> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 7fe9278f2c..18ace85465 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="TextServer" inherits="Object" version="4.0"> +<class name="TextServer" inherits="RefCounted" version="4.0"> <brief_description> Interface for the fonts and complex text layouts. </brief_description> @@ -487,8 +487,8 @@ </method> <method name="font_set_data"> <return type="void" /> - <argument index="0" name="data" type="RID" /> - <argument index="1" name="arg1" type="PackedByteArray" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data" type="PackedByteArray" /> <description> Sets font source data, e.g contents of the dynamic font source file. </description> @@ -714,12 +714,14 @@ <return type="Dictionary" /> <argument index="0" name="font_rid" type="RID" /> <description> + Returns the dictionary of the supported OpenType features. </description> </method> <method name="font_supported_variation_list" qualifiers="const"> <return type="Dictionary" /> <argument index="0" name="font_rid" type="RID" /> <description> + Returns the dictionary of the supported OpenType variation coordinates. </description> </method> <method name="format_number" qualifiers="const"> @@ -737,6 +739,12 @@ Frees an object created by this [TextServer]. </description> </method> + <method name="get_features" qualifiers="const"> + <return type="int" /> + <description> + Returns text server features, see [enum Feature]. + </description> + </method> <method name="get_hex_code_box_size" qualifiers="const"> <return type="Vector2" /> <argument index="0" name="size" type="int" /> @@ -751,6 +759,18 @@ Returns the name of the server interface. </description> </method> + <method name="get_support_data_filename" qualifiers="const"> + <return type="String" /> + <description> + Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. + </description> + </method> + <method name="get_support_data_info" qualifiers="const"> + <return type="String" /> + <description> + Returns TextServer database (e.g. ICU break iterators and dictionaries) description. + </description> + </method> <method name="has"> <return type="bool" /> <argument index="0" name="rid" type="RID" /> @@ -758,14 +778,14 @@ Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. </description> </method> - <method name="has_feature"> + <method name="has_feature" qualifiers="const"> <return type="bool" /> <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> <description> Returns [code]true[/code] if the server supports a feature. </description> </method> - <method name="is_locale_right_to_left"> + <method name="is_locale_right_to_left" qualifiers="const"> <return type="bool" /> <argument index="0" name="locale" type="String" /> <description> @@ -802,6 +822,14 @@ Returns percent sign used in the [code]language[/code]. </description> </method> + <method name="save_support_data" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. + Note: This function is used by during project export, to include TextServer database. + </description> + </method> <method name="shaped_text_add_object"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> @@ -898,7 +926,7 @@ Returns direction of the text. </description> </method> - <method name="shaped_text_get_dominant_direciton_in_range" qualifiers="const"> + <method name="shaped_text_get_dominant_direction_in_range" qualifiers="const"> <return type="int" enum="TextServer.Direction" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="start" type="int" /> @@ -907,30 +935,58 @@ Returns dominant direction of in the range of text. </description> </method> + <method name="shaped_text_get_ellipsis_glyph_count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the ellipsis. + </description> + </method> + <method name="shaped_text_get_ellipsis_glyphs" qualifiers="const"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns array of the glyphs in the ellipsis. + </description> + </method> + <method name="shaped_text_get_ellipsis_pos" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the ellipsis. + </description> + </method> + <method name="shaped_text_get_glyph_count" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the buffer. + </description> + </method> <method name="shaped_text_get_glyphs" qualifiers="const"> <return type="Array" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns text glyphs. + Returns text glyphs in the visual order. </description> </method> <method name="shaped_text_get_line_breaks" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="width" type="float" /> <argument index="2" name="start" type="int" default="0" /> - <argument index="3" name="break_flags" type="int" default="48" /> + <argument index="3" name="break_flags" type="int" default="96" /> <description> Breaks text to the lines and returns character ranges for each line. </description> </method> <method name="shaped_text_get_line_breaks_adv" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="width" type="PackedFloat32Array" /> <argument index="2" name="start" type="int" default="0" /> <argument index="3" name="once" type="bool" default="true" /> - <argument index="4" name="break_flags" type="int" default="48" /> + <argument index="4" name="break_flags" type="int" default="96" /> <description> Breaks text to the lines and columns. Returns character ranges for each segment. </description> @@ -987,7 +1043,7 @@ </description> </method> <method name="shaped_text_get_selection" qualifiers="const"> - <return type="Array" /> + <return type="PackedVector2Array" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="start" type="int" /> <argument index="2" name="end" type="int" /> @@ -1002,6 +1058,13 @@ Returns size of the text. </description> </method> + <method name="shaped_text_get_trim_pos" qualifiers="const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the trim. + </description> + </method> <method name="shaped_text_get_underline_position" qualifiers="const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> @@ -1024,8 +1087,9 @@ </description> </method> <method name="shaped_text_get_word_breaks" qualifiers="const"> - <return type="Array" /> + <return type="PackedInt32Array" /> <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="grapheme_flags" type="int" /> <description> Breaks text into words and returns array of character ranges. </description> @@ -1053,7 +1117,7 @@ Returns [code]true[/code] if buffer is successfully shaped. </description> </method> - <method name="shaped_text_next_grapheme_pos"> + <method name="shaped_text_next_grapheme_pos" qualifiers="const"> <return type="int" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="pos" type="int" /> @@ -1070,7 +1134,7 @@ Trims text if it exceeds the given width. </description> </method> - <method name="shaped_text_prev_grapheme_pos"> + <method name="shaped_text_prev_grapheme_pos" qualifiers="const"> <return type="int" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="pos" type="int" /> @@ -1139,6 +1203,13 @@ Note: It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. </description> </method> + <method name="shaped_text_sort_logical"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text glyphs in the logical order. + </description> + </method> <method name="shaped_text_substr" qualifiers="const"> <return type="RID" /> <argument index="0" name="shaped" type="RID" /> @@ -1196,18 +1267,24 @@ <constant name="JUSTIFICATION_AFTER_LAST_TAB" value="8" enum="JustificationFlag"> Only apply justification to the part of the text after the last tab. </constant> + <constant name="JUSTIFICATION_CONSTRAIN_ELLIPSIS" value="16" enum="JustificationFlag"> + Apply justification to the trimmed line with ellipsis. + </constant> <constant name="BREAK_NONE" value="0" enum="LineBreakFlag"> Do not break the line. </constant> - <constant name="BREAK_MANDATORY" value="16" enum="LineBreakFlag"> + <constant name="BREAK_MANDATORY" value="32" enum="LineBreakFlag"> Break the line at the line mandatory break characters (e.g. [code]"\n"[/code]). </constant> - <constant name="BREAK_WORD_BOUND" value="32" enum="LineBreakFlag"> + <constant name="BREAK_WORD_BOUND" value="64" enum="LineBreakFlag"> Break the line between the words. </constant> - <constant name="BREAK_GRAPHEME_BOUND" value="64" enum="LineBreakFlag"> + <constant name="BREAK_GRAPHEME_BOUND" value="128" enum="LineBreakFlag"> Break the line between any unconnected graphemes. </constant> + <constant name="BREAK_WORD_BOUND_ADAPTIVE" value="320" enum="LineBreakFlag"> + Break the line between the words, or any unconnected graphemes if line is too short to fit the whole word. + </constant> <constant name="OVERRUN_NO_TRIMMING" value="0" enum="TextOverrunFlag"> No trimming is performed. </constant> @@ -1223,6 +1300,11 @@ <constant name="OVERRUN_ENFORCE_ELLIPSIS" value="8" enum="TextOverrunFlag"> Determines whether the ellipsis at the end of the text is enforced and may not be hidden. </constant> + <constant name="OVERRUN_JUSTIFICATION_AWARE" value="16" enum="TextOverrunFlag"> + </constant> + <constant name="GRAPHEME_IS_VALID" value="1" enum="GraphemeFlag"> + Grapheme is supprted by the font, and can be drawn. + </constant> <constant name="GRAPHEME_IS_RTL" value="2" enum="GraphemeFlag"> Grapheme is part of right-to-left or bottom-to-top run. </constant> diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml new file mode 100644 index 0000000000..29571463d2 --- /dev/null +++ b/doc/classes/TextServerExtension.xml @@ -0,0 +1,1262 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextServerExtension" inherits="TextServer" version="4.0"> + <brief_description> + Base class for TextServer custom implementations (plugins). + </brief_description> + <description> + External TextServer implementations should inherit from this class. + </description> + <tutorials> + </tutorials> + <methods> + <method name="_create_font" qualifiers="virtual"> + <return type="RID" /> + <description> + Creates new, empty font cache entry resource. To free the resulting resourec, use [method _free] method. + </description> + </method> + <method name="_create_shaped_text" qualifiers="virtual"> + <return type="RID" /> + <argument index="0" name="direction" type="int" enum="TextServer.Direction" /> + <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <description> + Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method _free] method. + Note: Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + Note: Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + </description> + </method> + <method name="_draw_hex_code_box" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="index" type="int" /> + <argument index="4" name="color" type="Color" /> + <description> + Draws box displaying character hexadecimal code. Used for replacing missing characters. + </description> + </method> + <method name="_font_clear_glyphs" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes all rendered glyphs information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. + </description> + </method> + <method name="_font_clear_kerning_map" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Removes all kerning overrides. + </description> + </method> + <method name="_font_clear_size_cache" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Removes all font sizes from the cache entry + </description> + </method> + <method name="_font_clear_textures" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes all textures from font cache entry. Note: This function will not remove glyphs associated with the texture, use [method _font_remove_glyph] to remove them manually. + </description> + </method> + <method name="_font_draw_glyph" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="pos" type="Vector2" /> + <argument index="4" name="index" type="int" /> + <argument index="5" name="color" type="Color" /> + <description> + Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. + Note: Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. + </description> + </method> + <method name="_font_draw_glyph_outline" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="outline_size" type="int" /> + <argument index="4" name="pos" type="Vector2" /> + <argument index="5" name="index" type="int" /> + <argument index="6" name="color" type="Color" /> + <description> + Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. + Note: Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. + </description> + </method> + <method name="_font_get_ascent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="_font_get_descent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns the font descent (number of pixels below the baseline). + </description> + </method> + <method name="_font_get_fixed_size" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns bitmap font fixed size. + </description> + </method> + <method name="_font_get_global_oversampling" qualifiers="virtual const"> + <return type="float" /> + <description> + Returns the font oversampling factor, shared by all fonts in the TextServer. + </description> + </method> + <method name="_font_get_glyph_advance" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + </description> + </method> + <method name="_font_get_glyph_contours" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="index" type="int" /> + <description> + Returns outline contours of the glyph as a [code]Dictionary[/code] with the following contents: + [code]points[/code] - [PackedVector3Array], containing outline points. [code]x[/code] and [code]y[/code] are point coordinates. [code]z[/code] is the type of the point, using the [enum TextServer.ContourPointTag] values. + [code]contours[/code] - [PackedInt32Array], containing indices the end points of each contour. + [code]orientation[/code] - [bool], contour orientation. If [code]true[/code], clockwise contours must be filled. + </description> + </method> + <method name="_font_get_glyph_index" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="char" type="int" /> + <argument index="3" name="variation_selector" type="int" /> + <description> + Returns the glyph index of a [code]char[/code], optionally modified by the [code]variation_selector[/code]. + </description> + </method> + <method name="_font_get_glyph_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Returns list of rendered glyphs in the cache entry. + </description> + </method> + <method name="_font_get_glyph_offset" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns glyph offset from the baseline. + </description> + </method> + <method name="_font_get_glyph_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns size of the glyph. + </description> + </method> + <method name="_font_get_glyph_texture_idx" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns index of the cache texture containing the glyph. + </description> + </method> + <method name="_font_get_glyph_uv_rect" qualifiers="virtual const"> + <return type="Rect2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Returns rectangle in the cache texture containing the glyph. + </description> + </method> + <method name="_font_get_hinting" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the font hinting mode. Used by dynamic fonts only. + </description> + </method> + <method name="_font_get_kerning" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <description> + Returns kerning for the pair of glyphs. + </description> + </method> + <method name="_font_get_kerning_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns list of the kerning overrides. + </description> + </method> + <method name="_font_get_language_support_override" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Returns [code]true[/code] if support override is enabled for the [code]language[/code]. + </description> + </method> + <method name="_font_get_language_support_overrides" qualifiers="virtual"> + <return type="PackedStringArray" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns list of language support overrides. + </description> + </method> + <method name="_font_get_msdf_pixel_range" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Return the width of the range around the shape between the minimum and maximum representable signed distance. + </description> + </method> + <method name="_font_get_msdf_size" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns source font size used to generate MSDF textures. + </description> + </method> + <method name="_font_get_oversampling" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. + </description> + </method> + <method name="_font_get_scale" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns scaling factor of the color bitmap font. + </description> + </method> + <method name="_font_get_script_support_override" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Returns [code]true[/code] if support override is enabled for the [code]script[/code]. + </description> + </method> + <method name="_font_get_script_support_overrides" qualifiers="virtual"> + <return type="PackedStringArray" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns list of script support overrides. + </description> + </method> + <method name="_font_get_size_cache_list" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Return list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size. + </description> + </method> + <method name="_font_get_spacing" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> + <description> + Returns extra spacing added between glyphs in pixels. + </description> + </method> + <method name="_font_get_supported_chars" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns a string containing all the characters available in the font. + </description> + </method> + <method name="_font_get_texture_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Returns number of textures used by font cache entry. + </description> + </method> + <method name="_font_get_texture_image" qualifiers="virtual const"> + <return type="Image" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Returns font cache texture image data. + </description> + </method> + <method name="_font_get_texture_offsets" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. + </description> + </method> + <method name="_font_get_underline_position" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns pixel offset of the underline below the baseline. + </description> + </method> + <method name="_font_get_underline_thickness" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <description> + Returns thickness of the underline in pixels. + </description> + </method> + <method name="_font_get_variation_coordinates" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns variation coordinates for the specified font cache entry. See [method _font_supported_variation_list] for more info. + </description> + </method> + <method name="_font_has_char" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="char" type="int" /> + <description> + Return [code]true[/code] if a Unicode [code]char[/code] is available in the font. + </description> + </method> + <method name="_font_is_antialiased" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if font 8-bit anitialiased glyph rendering is supported and enabled. + </description> + </method> + <method name="_font_is_force_autohinter" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if auto-hinting is supported and preffered over font built-in hinting. Used by dynamic fonts only. + </description> + </method> + <method name="_font_is_language_supported" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Returns [code]true[/code], if font supports given language ([url=https://en.wikipedia.org/wiki/ISO_639-1]ISO 639[/url] code). + </description> + </method> + <method name="_font_is_multichannel_signed_distance_field" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns [code]true[/code] if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. + </description> + </method> + <method name="_font_is_script_supported" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Returns [code]true[/code], if font supports given script (ISO 15924 code). + </description> + </method> + <method name="_font_remove_glyph" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <description> + Removes specified rendered glyph information from the cache entry. Note: This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. + </description> + </method> + <method name="_font_remove_kerning" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <description> + Removes kerning override for the pair of glyphs. + </description> + </method> + <method name="_font_remove_language_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <description> + Remove language support override. + </description> + </method> + <method name="_font_remove_script_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <description> + Removes script support override. + </description> + </method> + <method name="_font_remove_size_cache" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <description> + Removes specified font size from the cache entry. + </description> + </method> + <method name="_font_remove_texture" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <description> + Removes specified texture from font cache entry. Note: This function will not remove glyphs associated with the texture, remove them manually, using [method _font_remove_glyph]. + </description> + </method> + <method name="_font_render_glyph" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="index" type="int" /> + <description> + Renders specified glyph the the font cache texture. + </description> + </method> + <method name="_font_render_range" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="end" type="int" /> + <description> + Renders the range of characters to the font cache texture. + </description> + </method> + <method name="_font_set_antialiased" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="antialiased" type="bool" /> + <description> + If set to [code]true[/code], 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_ascent" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="ascent" type="float" /> + <description> + Sets the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="_font_set_data" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data" type="PackedByteArray" /> + <description> + Sets font source data, e.g contents of the dynamic font source file. + </description> + </method> + <method name="_font_set_data_ptr" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="data_ptr" type="const uint8_t*" /> + <argument index="2" name="data_size" type="int" /> + <description> + Sets the font descent (number of pixels below the baseline). + </description> + </method> + <method name="_font_set_descent" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="descent" type="float" /> + <description> + Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes. + </description> + </method> + <method name="_font_set_fixed_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="fixed_size" type="int" /> + <description> + If set to [code]true[/code] auto-hinting is preffered over font built-in hinting. + </description> + </method> + <method name="_font_set_force_autohinter" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="force_autohinter" type="bool" /> + <description> + </description> + </method> + <method name="_font_set_global_oversampling" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="oversampling" type="float" /> + <description> + Sets oversampling factor, shared by all font in the TextServer. + Note: This value can be automaticaly changed by display server. + </description> + </method> + <method name="_font_set_glyph_advance" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="advance" type="Vector2" /> + <description> + Sets glyph advance (offset of the next glyph). Note: advance for glyphs outlines is the same as the base glyph advance and is not saved. + </description> + </method> + <method name="_font_set_glyph_offset" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="offset" type="Vector2" /> + <description> + Sets glyph offset from the baseline. + </description> + </method> + <method name="_font_set_glyph_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="gl_size" type="Vector2" /> + <description> + Sets size of the glyph. + </description> + </method> + <method name="_font_set_glyph_texture_idx" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="texture_idx" type="int" /> + <description> + Sets index of the cache texture containing the glyph. + </description> + </method> + <method name="_font_set_glyph_uv_rect" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="glyph" type="int" /> + <argument index="3" name="uv_rect" type="Rect2" /> + <description> + Sets rectangle in the cache texture containing the glyph. + </description> + </method> + <method name="_font_set_hinting" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="hinting" type="int" enum="TextServer.Hinting" /> + <description> + Sets font hinting mode. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_kerning" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="glyph_pair" type="Vector2i" /> + <argument index="3" name="kerning" type="Vector2" /> + <description> + Sets kerning for the pair of glyphs. + </description> + </method> + <method name="_font_set_language_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="language" type="String" /> + <argument index="2" name="supported" type="bool" /> + <description> + Adds override for [method _font_is_language_supported]. + </description> + </method> + <method name="_font_set_msdf_pixel_range" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf_pixel_range" type="int" /> + <description> + Sets the width of the range around the shape between the minimum and maximum representable signed distance. + </description> + </method> + <method name="_font_set_msdf_size" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf_size" type="int" /> + <description> + Sets source font size used to generate MSDF textures. + </description> + </method> + <method name="_font_set_multichannel_signed_distance_field" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="msdf" type="bool" /> + <description> + If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. + </description> + </method> + <method name="_font_set_oversampling" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="oversampling" type="float" /> + <description> + Sets font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only. + </description> + </method> + <method name="_font_set_scale" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="scale" type="float" /> + <description> + Sets scaling factor of the color bitmap font. + </description> + </method> + <method name="_font_set_script_support_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="script" type="String" /> + <argument index="2" name="supported" type="bool" /> + <description> + Adds override for [method _font_is_script_supported]. + </description> + </method> + <method name="_font_set_spacing" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="spacing" type="int" enum="TextServer.SpacingType" /> + <argument index="3" name="value" type="int" /> + <description> + Sets extra spacing added between glyphs in pixels. + </description> + </method> + <method name="_font_set_texture_image" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <argument index="3" name="image" type="Image" /> + <description> + Sets font cache texture image data. + </description> + </method> + <method name="_font_set_texture_offsets" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="Vector2i" /> + <argument index="2" name="texture_index" type="int" /> + <argument index="3" name="offset" type="PackedInt32Array" /> + <description> + Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty. + </description> + </method> + <method name="_font_set_underline_position" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="underline_position" type="float" /> + <description> + Sets pixel offset of the underline below the baseline. + </description> + </method> + <method name="_font_set_underline_thickness" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="size" type="int" /> + <argument index="2" name="underline_thickness" type="float" /> + <description> + Sets thickness of the underline in pixels. + </description> + </method> + <method name="_font_set_variation_coordinates" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="font_rid" type="RID" /> + <argument index="1" name="variation_coordinates" type="Dictionary" /> + <description> + Sets variation coordinates for the specified font cache entry. See [method _font_supported_variation_list] for more info. + </description> + </method> + <method name="_font_supported_feature_list" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the dictionary of the supported OpenType features. + </description> + </method> + <method name="_font_supported_variation_list" qualifiers="virtual const"> + <return type="Dictionary" /> + <argument index="0" name="font_rid" type="RID" /> + <description> + Returns the dictionary of the supported OpenType variation coordinates. + </description> + </method> + <method name="_format_number" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <argument index="1" name="language" type="String" /> + <description> + Converts a number from the Western Arabic (0..9) to the numeral systems used in [code]language[/code]. + </description> + </method> + <method name="_free" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="rid" type="RID" /> + <description> + Frees an object created by this [TextServer]. + </description> + </method> + <method name="_get_features" qualifiers="virtual const"> + <return type="int" /> + <description> + Returns text server features, see [enum TextServer.Feature]. + </description> + </method> + <method name="_get_hex_code_box_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="size" type="int" /> + <argument index="1" name="index" type="int" /> + <description> + Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters). + </description> + </method> + <method name="_get_name" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns the name of the server interface. + </description> + </method> + <method name="_get_support_data_filename" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename. + </description> + </method> + <method name="_get_support_data_info" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns TextServer database (e.g. ICU break iterators and dictionaries) description. + </description> + </method> + <method name="_has" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="rid" type="RID" /> + <description> + Returns [code]true[/code] if [code]rid[/code] is valid resource owned by this text server. + </description> + </method> + <method name="_has_feature" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="feature" type="int" enum="TextServer.Feature" /> + <description> + Returns [code]true[/code] if the server supports a feature. + </description> + </method> + <method name="_is_locale_right_to_left" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="locale" type="String" /> + <description> + Returns [code]true[/code] if locale is right-to-left. + </description> + </method> + <method name="_load_support_data" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Loads optional TextServer database (e.g. ICU break iterators and dictionaries). + Note: This function should be called before any other TextServer functions used, otherwise it won't have any effect. + </description> + </method> + <method name="_name_to_tag" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="name" type="String" /> + <description> + Converts readable feature, variation, script or language name to OpenType tag. + </description> + </method> + <method name="_parse_number" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <argument index="1" name="language" type="String" /> + <description> + Converts a number from the numeral systems used in [code]language[/code] to Western Arabic (0..9). + </description> + </method> + <method name="_percent_sign" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="language" type="String" /> + <description> + Returns percent sign used in the [code]language[/code]. + </description> + </method> + <method name="_save_support_data" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="filename" type="String" /> + <description> + Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file. + Note: This function is used by during project export, to include TextServer database. + </description> + </method> + <method name="_shaped_text_add_object" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <argument index="2" name="size" type="Vector2" /> + <argument index="3" name="inline_align" type="int" enum="InlineAlign" /> + <argument index="4" name="length" type="int" /> + <description> + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. + </description> + </method> + <method name="_shaped_text_add_string" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="text" type="String" /> + <argument index="2" name="fonts" type="Array" /> + <argument index="3" name="size" type="int" /> + <argument index="4" name="opentype_features" type="Dictionary" /> + <argument index="5" name="language" type="String" /> + <description> + Adds text span and font to draw it to the text buffer. + </description> + </method> + <method name="_shaped_text_clear" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Clears text buffer (removes text and inline objects). + </description> + </method> + <method name="_shaped_text_draw" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="clip_l" type="float" /> + <argument index="4" name="clip_r" type="float" /> + <argument index="5" name="color" type="Color" /> + <description> + Draw shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). + </description> + </method> + <method name="_shaped_text_draw_outline" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="canvas" type="RID" /> + <argument index="2" name="pos" type="Vector2" /> + <argument index="3" name="clip_l" type="float" /> + <argument index="4" name="clip_r" type="float" /> + <argument index="5" name="outline_size" type="int" /> + <argument index="6" name="color" type="Color" /> + <description> + Draw the outline of the shaped text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout). + </description> + </method> + <method name="_shaped_text_fit_to_width" qualifiers="virtual"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="jst_flags" type="int" /> + <description> + Adjusts text with to fit to specified width, returns new text width + </description> + </method> + <method name="_shaped_text_get_ascent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). + Note: overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. + </description> + </method> + <method name="_shaped_text_get_carets" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="position" type="int" /> + <argument index="2" name="caret" type="CaretInfo*" /> + <description> + Returns shapes of the carets corresponding to the character offset [code]position[/code] in the text. Returned caret shape is 1 pixel wide rectangle. + </description> + </method> + <method name="_shaped_text_get_descent" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). + Note: overall descent can be higher than font descent, if some glyphs are displaced from the baseline. + </description> + </method> + <method name="_shaped_text_get_direction" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns direction of the text. + </description> + </method> + <method name="_shaped_text_get_dominant_direction_in_range" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="end" type="int" /> + <description> + Returns dominant direction of in the range of text. + </description> + </method> + <method name="_shaped_text_get_ellipsis_glyph_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns number of glyphs in the ellipsis. + </description> + </method> + <method name="_shaped_text_get_ellipsis_glyphs" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Returns array of the glyphs in the ellipsis. + </description> + </method> + <method name="_shaped_text_get_ellipsis_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns position of the ellipsis. + </description> + </method> + <method name="_shaped_text_get_glyph_count" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text glyphs count. + </description> + </method> + <method name="_shaped_text_get_glyphs" qualifiers="virtual const"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Copies text glyphs in the visual order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + </description> + </method> + <method name="_shaped_text_get_line_breaks" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="break_flags" type="int" /> + <description> + Breaks text to the lines and returns character ranges for each line. + </description> + </method> + <method name="_shaped_text_get_line_breaks_adv" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="PackedFloat32Array" /> + <argument index="2" name="start" type="int" /> + <argument index="3" name="once" type="bool" /> + <argument index="4" name="break_flags" type="int" /> + <description> + Breaks text to the lines and columns. Returns character ranges for each segment. + </description> + </method> + <method name="_shaped_text_get_object_rect" qualifiers="virtual const"> + <return type="Rect2" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <description> + Returns bounding rectangle of the inline object. + </description> + </method> + <method name="_shaped_text_get_objects" qualifiers="virtual const"> + <return type="Array" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns array of inline objects. + </description> + </method> + <method name="_shaped_text_get_orientation" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns text orientation. + </description> + </method> + <method name="_shaped_text_get_parent" qualifiers="virtual const"> + <return type="RID" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Sets text orientation. + </description> + </method> + <method name="_shaped_text_get_preserve_control" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if text buffer is configured to display control characters. + </description> + </method> + <method name="_shaped_text_get_preserve_invalid" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if text buffer is configured to display hexadecimal codes in place of invalid characters. + Note: If set to [code]false[/code], nothing is displayed in place of invalid characters. + </description> + </method> + <method name="_shaped_text_get_range" qualifiers="virtual const"> + <return type="Vector2i" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns substring buffer character range in the parent buffer. + </description> + </method> + <method name="_shaped_text_get_selection" qualifiers="virtual const"> + <return type="PackedVector2Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="end" type="int" /> + <description> + Returns selection rectangles for the specified character range. + </description> + </method> + <method name="_shaped_text_get_size" qualifiers="virtual const"> + <return type="Vector2" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns size of the text. + </description> + </method> + <method name="_shaped_text_get_trim_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns ellipsis and trim positions. + </description> + </method> + <method name="_shaped_text_get_underline_position" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns pixel offset of the underline below the baseline. + </description> + </method> + <method name="_shaped_text_get_underline_thickness" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns thickness of the underline. + </description> + </method> + <method name="_shaped_text_get_width" qualifiers="virtual const"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns width (for horizontal layout) or height (for vertical) of the text. + </description> + </method> + <method name="_shaped_text_get_word_breaks" qualifiers="virtual const"> + <return type="PackedInt32Array" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="grapheme_flags" type="int" /> + <description> + Breaks text into words and returns array of character ranges. + </description> + </method> + <method name="_shaped_text_hit_test_grapheme" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="coord" type="float" /> + <description> + Returns grapheme index at the specified pixel offset at the baseline, or [code]-1[/code] if none is found. + </description> + </method> + <method name="_shaped_text_hit_test_position" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="coord" type="float" /> + <description> + Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position. + </description> + </method> + <method name="_shaped_text_is_ready" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Returns [code]true[/code] if buffer is successfully shaped. + </description> + </method> + <method name="_shaped_text_next_grapheme_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character end position closest to the [code]pos[/code]. + </description> + </method> + <method name="_shaped_text_overrun_trim_to_width" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="width" type="float" /> + <argument index="2" name="trim_flags" type="int" /> + <description> + Trims text if it exceeds the given width. + </description> + </method> + <method name="_shaped_text_prev_grapheme_pos" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="pos" type="int" /> + <description> + Returns composite character start position closest to the [code]pos[/code]. + </description> + </method> + <method name="_shaped_text_resize_object" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="key" type="Variant" /> + <argument index="2" name="size" type="Vector2" /> + <argument index="3" name="inline_align" type="int" enum="InlineAlign" /> + <description> + Sets new size and alignment of embedded object. + </description> + </method> + <method name="_shaped_text_set_bidi_override" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="override" type="Array" /> + <description> + Overrides BiDi for the structured text. + Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. + </description> + </method> + <method name="_shaped_text_set_direction" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="direction" type="int" enum="TextServer.Direction" /> + <description> + Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. + Note: Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. + </description> + </method> + <method name="_shaped_text_set_orientation" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> + <description> + Sets desired text orientation. + Note: Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + </description> + </method> + <method name="_shaped_text_set_preserve_control" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="enabled" type="bool" /> + <description> + If set to [code]true[/code] text buffer will display control characters. + </description> + </method> + <method name="_shaped_text_set_preserve_invalid" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="enabled" type="bool" /> + <description> + If set to [code]true[/code] text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed. + </description> + </method> + <method name="_shaped_text_shape" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. + Note: It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. + </description> + </method> + <method name="_shaped_text_sort_logical" qualifiers="virtual"> + <return type="void" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="r_glyphs" type="void*" /> + <description> + Copies text glyphs in the logical order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + </description> + </method> + <method name="_shaped_text_substr" qualifiers="virtual const"> + <return type="RID" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="start" type="int" /> + <argument index="2" name="length" type="int" /> + <description> + Returns text buffer for the substring of the text in the [code]shaped[/code] text buffer (including inline objects). + </description> + </method> + <method name="_shaped_text_tab_align" qualifiers="virtual"> + <return type="float" /> + <argument index="0" name="shaped" type="RID" /> + <argument index="1" name="tab_stops" type="PackedFloat32Array" /> + <description> + Aligns shaped text to the given tab-stops. + </description> + </method> + <method name="_shaped_text_update_breaks" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Updates line and word breaks. + </description> + </method> + <method name="_shaped_text_update_justification_ops" qualifiers="virtual"> + <return type="bool" /> + <argument index="0" name="shaped" type="RID" /> + <description> + Updates justification opportunities (spaces, kashidas, etc.). + </description> + </method> + <method name="_tag_to_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="tag" type="int" /> + <description> + Converts OpenType tag to readable feature, variation, script or language name. + </description> + </method> + </methods> +</class> diff --git a/doc/classes/TextServerManager.xml b/doc/classes/TextServerManager.xml index 0e7b6d15d3..aa2177c3b1 100644 --- a/doc/classes/TextServerManager.xml +++ b/doc/classes/TextServerManager.xml @@ -10,6 +10,13 @@ <tutorials> </tutorials> <methods> + <method name="add_interface"> + <return type="void" /> + <argument index="0" name="interface" type="TextServer" /> + <description> + Registers an [TextServer] interface. + </description> + </method> <method name="find_interface" qualifiers="const"> <return type="TextServer" /> <argument index="0" name="name" type="String" /> @@ -19,7 +26,7 @@ </method> <method name="get_interface" qualifiers="const"> <return type="TextServer" /> - <argument index="0" name="index" type="int" /> + <argument index="0" name="idx" type="int" /> <description> Returns the interface registered at a given index. </description> @@ -30,20 +37,6 @@ Returns the number of interfaces currently registered. </description> </method> - <method name="get_interface_features" qualifiers="const"> - <return type="int" /> - <argument index="0" name="index" type="int" /> - <description> - Returns text server supported features (binary OR). - </description> - </method> - <method name="get_interface_name" qualifiers="const"> - <return type="String" /> - <argument index="0" name="index" type="int" /> - <description> - Returns the interface name registered at a given index. - </description> - </method> <method name="get_interfaces" qualifiers="const"> <return type="Array" /> <description> @@ -53,15 +46,36 @@ <method name="get_primary_interface" qualifiers="const"> <return type="TextServer" /> <description> - Returns the primary [TextServer] interface. + Returns the primary [TextServer] interface currently in use. + </description> + </method> + <method name="remove_interface"> + <return type="void" /> + <argument index="0" name="interface" type="TextServer" /> + <description> + Removes interface. All fonts and shaped text caches should be freed before removing interface. </description> </method> <method name="set_primary_interface"> - <return type="bool" /> - <argument index="0" name="index" type="int" /> + <return type="void" /> + <argument index="0" name="index" type="TextServer" /> <description> - Sets (and initializes it if required) interface registered at a given index as the primary. Invalidates all references to the fonts and text buffers. + Sets the primary [TextServer] interface. </description> </method> </methods> + <signals> + <signal name="interface_added"> + <argument index="0" name="interface_name" type="StringName" /> + <description> + Emitted when a new interface has been added. + </description> + </signal> + <signal name="interface_removed"> + <argument index="0" name="interface_name" type="StringName" /> + <description> + Emitted when an interface is removed. + </description> + </signal> + </signals> </class> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index edf5874432..2f5648dda9 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -273,6 +273,24 @@ Returns [code]false[/code] if the theme does not have [code]theme_type[/code]. </description> </method> + <method name="has_default_base_scale" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_base_scale] value. + </description> + </method> + <method name="has_default_font" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_font] value. + </description> + </method> + <method name="has_default_font_size" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this theme has a valid [member default_font_size] value. + </description> + </method> <method name="has_font" qualifiers="const"> <return type="bool" /> <argument index="0" name="name" type="StringName" /> @@ -484,11 +502,17 @@ </method> </methods> <members> + <member name="default_base_scale" type="float" setter="set_default_base_scale" getter="get_default_base_scale" default="0.0"> + The default base scale factor of this [Theme] resource. Used by some controls to scale their visual properties based on a global scale factor. If this value is set to [code]0.0[/code], the global scale factor is used. + Use [method has_default_base_scale] to check if this value is valid. + </member> <member name="default_font" type="Font" setter="set_default_font" getter="get_default_font"> - The theme's default font. + The default font of this [Theme] resource. Used as a fallback value for font items defined in this theme, but having invalid values. If this value is also invalid, the global default value is used. + Use [method has_default_font] to check if this value is valid. </member> <member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1"> - The theme's default font size. Set to [code]-1[/code] to ignore and use global default. + The default font size of this [Theme] resource. Used as a fallback value for font size items defined in this theme, but having invalid values. If this value is set to [code]-1[/code], the global default value is used. + Use [method has_default_font_size] to check if this value is valid. </member> </members> <constants> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index e5fe823be6..532c9a7128 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -73,7 +73,7 @@ <return type="Vector2i" /> <argument index="0" name="body" type="RID" /> <description> - Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [member KinematicCollision2D.collider_rid], when colliding with a tile. + Returns the coodinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile. </description> </method> <method name="get_layer_name" qualifiers="const"> diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 15d844aacb..0653c8b453 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -59,6 +59,21 @@ <description> </description> </method> + <method name="get_theme_default_base_scale" qualifiers="const"> + <return type="float" /> + <description> + </description> + </method> + <method name="get_theme_default_font" qualifiers="const"> + <return type="Font" /> + <description> + </description> + </method> + <method name="get_theme_default_font_size" qualifiers="const"> + <return type="int" /> + <description> + </description> + </method> <method name="get_theme_font" qualifiers="const"> <return type="Font" /> <argument index="0" name="name" type="StringName" /> |