diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AnimationNodeBlendTree.xml | 3 | ||||
| -rw-r--r-- | doc/classes/CanvasItem.xml | 20 | ||||
| -rw-r--r-- | doc/classes/Font.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Input.xml | 10 | ||||
| -rw-r--r-- | doc/classes/InputEvent.xml | 10 | ||||
| -rw-r--r-- | doc/classes/InputMap.xml | 2 | ||||
| -rw-r--r-- | doc/classes/MultiplayerPeerExtension.xml | 18 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 3 | ||||
| -rw-r--r-- | doc/classes/Object.xml | 3 | ||||
| -rw-r--r-- | doc/classes/OptionButton.xml | 1 | ||||
| -rw-r--r-- | doc/classes/PhysicsServer3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/RichTextLabel.xml | 16 | ||||
| -rw-r--r-- | doc/classes/String.xml | 24 | ||||
| -rw-r--r-- | doc/classes/TextServer.xml | 53 | ||||
| -rw-r--r-- | doc/classes/TextServerDummy.xml | 9 | ||||
| -rw-r--r-- | doc/classes/TextServerExtension.xml | 450 |
16 files changed, 373 insertions, 257 deletions
diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index 20eb349363..fcdd09f144 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -4,7 +4,8 @@ [AnimationTree] node resource that contains many blend type nodes. </brief_description> <description> - This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots. + This node may contain a sub-tree of any other blend type nodes, such as [AnimationNodeTransition], [AnimationNodeBlend2], [AnimationNodeBlend3], [AnimationNodeOneShot], etc. This is one of the most commonly used roots. + An [AnimationNodeOutput] node named [code]output[/code] is created by default. </description> <tutorials> <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index c7451509f3..1fe2f5a756 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -80,6 +80,17 @@ Draws a colored polygon of any amount of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon. </description> </method> + <method name="draw_dashed_line"> + <return type="void" /> + <argument index="0" name="from" type="Vector2" /> + <argument index="1" name="to" type="Vector2" /> + <argument index="2" name="color" type="Color" /> + <argument index="3" name="width" type="float" default="1.0" /> + <argument index="4" name="dash" type="float" default="2.0" /> + <description> + Draws a dashed line from a 2D point to another, with a given color and width. See also [method draw_multiline] and [method draw_polyline]. + </description> + </method> <method name="draw_end_animation"> <return type="void" /> <description> @@ -428,14 +439,14 @@ <return type="void" /> <argument index="0" name="enable" type="bool" /> <description> - If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. + If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_LOCAL_TRANSFORM_CHANGED] when its local transform changes. </description> </method> <method name="set_notify_transform"> <return type="void" /> <argument index="0" name="enable" type="bool" /> <description> - If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. + If [code]enable[/code] is [code]true[/code], this node will receive [constant NOTIFICATION_TRANSFORM_CHANGED] when its global transform changes. </description> </method> <method name="show"> @@ -513,7 +524,10 @@ </signals> <constants> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000"> - The [CanvasItem]'s transform has changed. This notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform]. + The [CanvasItem]'s global transform has changed. This notification is only received if enabled by [method set_notify_transform]. + </constant> + <constant name="NOTIFICATION_LOCAL_TRANSFORM_CHANGED" value="35"> + The [CanvasItem]'s local transform has changed. This notification is only received if enabled by [method set_notify_local_transform]. </constant> <constant name="NOTIFICATION_DRAW" value="30"> The [CanvasItem] is requested to draw. diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 4ba15d7afc..f357cb05b5 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -191,6 +191,12 @@ See also [method draw_multiline_string]. </description> </method> + <method name="get_rids" qualifiers="const"> + <return type="Array" /> + <description> + Returns [Array] of valid [FontData] [RID]s, which can be passsed to the [TextServer] methods. + </description> + </method> <method name="get_spacing" qualifiers="const"> <return type="int" /> <argument index="0" name="spacing" type="int" enum="TextServer.SpacingType" /> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 2cbcfb8d9b..64a914bb31 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -58,7 +58,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use [method get_action_strength] instead. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="get_action_strength" qualifiers="const"> @@ -67,7 +67,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="get_axis" qualifiers="const"> @@ -186,7 +186,7 @@ <description> Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. </description> </method> @@ -196,7 +196,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -205,7 +205,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. </description> </method> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index cbed163f18..230ad04b33 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -33,7 +33,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="is_action" qualifiers="const"> @@ -42,7 +42,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if this input event matches a pre-defined action of any type. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -52,7 +52,7 @@ <argument index="2" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. [b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information. </description> </method> @@ -62,7 +62,7 @@ <argument index="1" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="is_action_type" qualifiers="const"> @@ -83,7 +83,7 @@ <argument index="1" name="exact_match" type="bool" default="true" /> <description> Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="is_pressed" qualifiers="const"> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index ac5921404c..61d54e85f8 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -86,7 +86,7 @@ <argument index="2" name="exact_match" type="bool" default="false" /> <description> Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. - If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. + If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> <method name="get_actions"> diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml index c5fe04cb32..bd11c76039 100644 --- a/doc/classes/MultiplayerPeerExtension.xml +++ b/doc/classes/MultiplayerPeerExtension.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="MultiplayerPeerExtension" inherits="MultiplayerPeer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Class that can be inherited to implement custom multiplayer API networking layers via GDExtension. </brief_description> <description> + This class is designed to be inherited from a GDExtension plugin to implement custom networking layers for the multiplayer API (such as WebRTC). All the methods below [b]must[/b] be implemented to have a working custom multiplayer implementation. See also [MultiplayerAPI]. </description> <tutorials> </tutorials> @@ -10,16 +12,19 @@ <method name="_get_available_packet_count" qualifiers="virtual const"> <return type="int" /> <description> + Called when the available packet count is internally requested by the [MultiplayerAPI]. </description> </method> <method name="_get_connection_status" qualifiers="virtual const"> <return type="int" /> <description> + Called when the connection status is requested on the [MultiplayerPeer] (see [method MultiplayerPeer.get_connection_status]). </description> </method> <method name="_get_max_packet_size" qualifiers="virtual const"> <return type="int" /> <description> + Called when the maximum allowed packet size (in bytes) is requested by the [MultiplayerAPI]. </description> </method> <method name="_get_packet" qualifiers="virtual"> @@ -27,41 +32,49 @@ <argument index="0" name="r_buffer" type="const uint8_t **" /> <argument index="1" name="r_buffer_size" type="int32_t*" /> <description> + Called when a packet needs to be received by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. </description> </method> <method name="_get_packet_peer" qualifiers="virtual const"> <return type="int" /> <description> + Called when the ID of the [MultiplayerPeer] who sent the most recent packet is requested (see [method MultiplayerPeer.get_packet_peer]). </description> </method> <method name="_get_transfer_channel" qualifiers="virtual const"> <return type="int" /> <description> + Called when the transfer channel to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). </description> </method> <method name="_get_transfer_mode" qualifiers="virtual const"> <return type="int" /> <description> + Called when the transfer mode to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). </description> </method> <method name="_get_unique_id" qualifiers="virtual const"> <return type="int" /> <description> + Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). </description> </method> <method name="_is_refusing_new_connections" qualifiers="virtual const"> <return type="bool" /> <description> + Called when the "refuse new connections" status is requested on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). </description> </method> <method name="_is_server" qualifiers="virtual const"> <return type="bool" /> <description> + Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server]. </description> </method> <method name="_poll" qualifiers="virtual"> <return type="int" /> <description> + Called when the [MultiplayerAPI] is polled. See [method MultiplayerAPI.poll]. </description> </method> <method name="_put_packet" qualifiers="virtual"> @@ -69,30 +82,35 @@ <argument index="0" name="p_buffer" type="const uint8_t*" /> <argument index="1" name="p_buffer_size" type="int" /> <description> + Called when a packet needs to be sent by the [MultiplayerAPI], with [code]p_buffer_size[/code] being the size of the binary [code]p_buffer[/code] in bytes. </description> </method> <method name="_set_refuse_new_connections" qualifiers="virtual"> <return type="void" /> <argument index="0" name="p_enable" type="bool" /> <description> + Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). </description> </method> <method name="_set_target_peer" qualifiers="virtual"> <return type="void" /> <argument index="0" name="p_peer" type="int" /> <description> + Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]). </description> </method> <method name="_set_transfer_channel" qualifiers="virtual"> <return type="void" /> <argument index="0" name="p_channel" type="int" /> <description> + Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). </description> </method> <method name="_set_transfer_mode" qualifiers="virtual"> <return type="void" /> <argument index="0" name="p_mode" type="int" /> <description> + Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). </description> </method> </methods> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 5291ecab08..28b104e276 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -133,7 +133,7 @@ [/csharp] [/codeblocks] If you need the child node to be added below a specific node in the list of children, use [method add_sibling] instead of this method. - [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=https://godot.readthedocs.io/en/latest/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=https://godot.readthedocs.io/en/latest/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view. + [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=$DOCS_URL/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=$DOCS_URL/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view. </description> </method> <method name="add_sibling"> @@ -717,6 +717,7 @@ </member> <member name="owner" type="Node" setter="set_owner" getter="get_owner"> The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using [PackedScene]), all the nodes it owns will be saved with it. This allows for the creation of complex [SceneTree]s, with instancing and subinstancing. + [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=$DOCS_URL/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=$DOCS_URL/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view. </member> <member name="process_mode" type="int" setter="set_process_mode" getter="get_process_mode" enum="Node.ProcessMode" default="0"> Can be used to pause or unpause the node, or make the node paused based on the [SceneTree], or make it inherit the process mode from its parent (default). diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index a57101b62d..d09f3a2b0d 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -53,7 +53,8 @@ <method name="_init" qualifiers="virtual"> <return type="void" /> <description> - Called when the object is initialized. + Called when the object is initialized in memory. Can be defined to take in parameters, that are passed in when constructing. + [b]Note:[/b] If [method _init] is defined with required parameters, then explicit construction is the only valid means of creating an Object of the class. If any other means (such as [method PackedScene.instantiate]) is used, then initialization will fail. </description> </method> <method name="_notification" qualifiers="virtual"> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index 69e6d4b74c..25e41116a2 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -6,6 +6,7 @@ <description> OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. See also [BaseButton] which contains common properties and methods associated with this node. + [b]Note:[/b] Properties [member Button.text] and [member Button.icon] are automatically set based on the selected item. They shouldn't be changed manually. </description> <tutorials> </tutorials> diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 7a9a0ac7c5..2e84287227 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -733,7 +733,7 @@ <return type="int" /> <argument index="0" name="process_info" type="int" enum="PhysicsServer3D.ProcessInfo" /> <description> - Returns an Info defined by the [enum ProcessInfo] input given. + Returns information about the current state of the 3D physics engine. See [enum ProcessInfo] for a list of available states. </description> </method> <method name="heightmap_shape_create"> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index d5e134fc60..e805d3469c 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -256,6 +256,13 @@ Adds a [code][font_size][/code] tag to the tag stack. Overrides default font size for its duration. </description> </method> + <method name="push_hint"> + <return type="void" /> + <argument index="0" name="description" type="String" /> + <description> + Adds a [code][hint][/code] tag to the tag stack. Same as BBCode [code][hint=something]{text}[/hint][/code]. + </description> + </method> <method name="push_indent"> <return type="void" /> <argument index="0" name="level" type="int" /> @@ -424,6 +431,9 @@ If [code]true[/code], the label's height will be automatically updated to fit its content. [b]Note:[/b] This property is used as a workaround to fix issues with [RichTextLabel] in [Container]s, but it's unreliable in some cases and will be removed in future versions. </member> + <member name="hint_underlined" type="bool" setter="set_hint_underline" getter="is_hint_underlined" default="true"> + If [code]true[/code], the label underlines hint tags such as [code][hint=description]{text}[/hint][/code]. + </member> <member name="language" type="String" setter="set_language" getter="get_language" default=""""> Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </member> @@ -563,9 +573,11 @@ </constant> <constant name="ITEM_META" value="23" enum="ItemType"> </constant> - <constant name="ITEM_DROPCAP" value="24" enum="ItemType"> + <constant name="ITEM_HINT" value="24" enum="ItemType"> + </constant> + <constant name="ITEM_DROPCAP" value="25" enum="ItemType"> </constant> - <constant name="ITEM_CUSTOMFX" value="25" enum="ItemType"> + <constant name="ITEM_CUSTOMFX" value="26" enum="ItemType"> </constant> <constant name="VC_CHARS_BEFORE_SHAPING" value="0" enum="VisibleCharactersBehavior"> Trims text before the shaping. e.g, increasing [member visible_characters] value is visually identical to typing the text. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index ea0bd2adb1..9a6155c8a8 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -514,12 +514,30 @@ [/codeblock] </description> </method> + <method name="num_int64" qualifiers="static"> + <return type="String" /> + <argument index="0" name="number" type="int" /> + <argument index="1" name="base" type="int" default="10" /> + <argument index="2" name="capitalize_hex" type="bool" default="false" /> + <description> + Converts a signed [int] to a string representation of a number. + </description> + </method> <method name="num_scientific" qualifiers="static"> <return type="String" /> <argument index="0" name="number" type="float" /> <description> </description> </method> + <method name="num_uint64" qualifiers="static"> + <return type="String" /> + <argument index="0" name="number" type="int" /> + <argument index="1" name="base" type="int" default="10" /> + <argument index="2" name="capitalize_hex" type="bool" default="false" /> + <description> + Converts a unsigned [int] to a string representation of a number. + </description> + </method> <method name="pad_decimals" qualifiers="const"> <return type="String" /> <argument index="0" name="digits" type="int" /> @@ -887,6 +905,12 @@ <description> </description> </operator> + <operator name="operator +"> + <return type="String" /> + <argument index="0" name="right" type="int" /> + <description> + </description> + </operator> <operator name="operator <"> <return type="bool" /> <argument index="0" name="right" type="String" /> diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 020c30b9cd..b4339bef11 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -57,7 +57,7 @@ <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <description> - Removes all font sizes from the cache entry + Removes all font sizes from the cache entry. </description> </method> <method name="font_clear_textures"> @@ -509,7 +509,7 @@ <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="index" type="int" /> <description> - Renders specified glyph the the font cache texture. + Renders specified glyph to the font cache texture. </description> </method> <method name="font_render_range"> @@ -1112,7 +1112,7 @@ <return type="Array" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns text glyphs in the visual order. + Returns an array of glyphs in the visual order. </description> </method> <method name="shaped_text_get_grapheme_bounds" qualifiers="const"> @@ -1177,7 +1177,7 @@ <return type="RID" /> <argument index="0" name="shaped" type="RID" /> <description> - Sets text orientation. + Returns the parent buffer from which the substring originates. </description> </method> <method name="shaped_text_get_preserve_control" qualifiers="const"> @@ -1222,7 +1222,7 @@ <return type="int" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns position of the trim. + Returns the position of the overrun trim. </description> </method> <method name="shaped_text_get_underline_position" qualifiers="const"> @@ -1420,6 +1420,7 @@ <argument index="0" name="string" type="String" /> <description> Strips diacritics from the string. + [b]Note:[/b] The result may be longer or shorter than the original. </description> </method> <method name="tag_to_name" qualifiers="const"> @@ -1544,8 +1545,8 @@ </constant> <constant name="SUBPIXEL_POSITIONING_AUTO" value="1" enum="SubpixelPositioning"> Glyph horizontal position is rounded based on font size. - - To one quarter of the pixel size if font size is smaller or equal to [code]16[/code]. - - To one half of the pixel size if font size is smaller or equal to [code]20[/code]. + - To one quarter of the pixel size if font size is smaller or equal to [constant SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE]. + - To one half of the pixel size if font size is smaller or equal to [constant SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE]. - To the whole pixel size for larger fonts. </constant> <constant name="SUBPIXEL_POSITIONING_ONE_HALF" value="2" enum="SubpixelPositioning"> @@ -1554,31 +1555,49 @@ <constant name="SUBPIXEL_POSITIONING_ONE_QUARTER" value="3" enum="SubpixelPositioning"> Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times. </constant> - <constant name="FEATURE_BIDI_LAYOUT" value="1" enum="Feature"> - TextServer supports bidirectional layouts. + <constant name="SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE" value="20" enum="SubpixelPositioning"> + Maximum font size which will use one half of the pixel subpixel positioning in [constants SUBPIXEL_POSITIONING_AUTO] mode. + </constant> + <constant name="SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE" value="16" enum="SubpixelPositioning"> + Maximum font size which will use one quarter of the pixel subpixel positioning in [constants SUBPIXEL_POSITIONING_AUTO] mode. + </constant> + <constant name="FEATURE_SIMPLE_LAYOUT" value="1" enum="Feature"> + TextServer supports simple text layouts. + </constant> + <constant name="FEATURE_BIDI_LAYOUT" value="2" enum="Feature"> + TextServer supports bidirectional text layouts. </constant> - <constant name="FEATURE_VERTICAL_LAYOUT" value="2" enum="Feature"> + <constant name="FEATURE_VERTICAL_LAYOUT" value="4" enum="Feature"> TextServer supports vertical layouts. </constant> - <constant name="FEATURE_SHAPING" value="4" enum="Feature"> + <constant name="FEATURE_SHAPING" value="8" enum="Feature"> TextServer supports complex text shaping. </constant> - <constant name="FEATURE_KASHIDA_JUSTIFICATION" value="8" enum="Feature"> + <constant name="FEATURE_KASHIDA_JUSTIFICATION" value="16" enum="Feature"> TextServer supports justification using kashidas. </constant> - <constant name="FEATURE_BREAK_ITERATORS" value="16" enum="Feature"> + <constant name="FEATURE_BREAK_ITERATORS" value="32" enum="Feature"> TextServer supports complex line/word breaking rules (e.g. dictionary based). </constant> - <constant name="FEATURE_FONT_SYSTEM" value="32" enum="Feature"> + <constant name="FEATURE_FONT_BITMAP" value="64" enum="Feature"> + TextServer supports loading bitmap fonts. + </constant> + <constant name="FEATURE_FONT_DYNAMIC" value="128" enum="Feature"> + TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts. + </constant> + <constant name="FEATURE_FONT_MSDF" value="256" enum="Feature"> + TextServer supports multichannel signed distance field dynamic font rendering. + </constant> + <constant name="FEATURE_FONT_SYSTEM" value="512" enum="Feature"> TextServer supports loading system fonts. </constant> - <constant name="FEATURE_FONT_VARIABLE" value="64" enum="Feature"> + <constant name="FEATURE_FONT_VARIABLE" value="1024" enum="Feature"> TextServer supports variable fonts. </constant> - <constant name="FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION" value="128" enum="Feature"> + <constant name="FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION" value="2048" enum="Feature"> TextServer supports locale dependent and context sensitive case conversion. </constant> - <constant name="FEATURE_USE_SUPPORT_DATA" value="256" enum="Feature"> + <constant name="FEATURE_USE_SUPPORT_DATA" value="4096" enum="Feature"> TextServer require external data file for some features. </constant> <constant name="CONTOUR_CURVE_TAG_ON" value="1" enum="ContourPointTag"> diff --git a/doc/classes/TextServerDummy.xml b/doc/classes/TextServerDummy.xml new file mode 100644 index 0000000000..b872e93fd6 --- /dev/null +++ b/doc/classes/TextServerDummy.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextServerDummy" inherits="TextServerExtension" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> +</class> diff --git a/doc/classes/TextServerExtension.xml b/doc/classes/TextServerExtension.xml index 5ffd80bf63..25647e2668 100644 --- a/doc/classes/TextServerExtension.xml +++ b/doc/classes/TextServerExtension.xml @@ -9,23 +9,21 @@ <tutorials> </tutorials> <methods> - <method name="_create_font" qualifiers="virtual"> + <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. + Creates new, empty font cache entry resource. To free the resulting resourec, use [method free_rid] method. </description> </method> - <method name="_create_shaped_text" qualifiers="virtual"> + <method name="create_shaped_text" qualifiers="virtual"> <return type="RID" /> <argument index="0" name="direction" type="int" enum="TextServer.Direction" /> <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> <description> - Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method _free] method. - [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. - [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. + Creates new buffer for complex text layout, with the given [code]direction[/code] and [code]orientation[/code]. To free the resulting buffer, use [method free_rid] method. </description> </method> - <method name="_draw_hex_code_box" qualifiers="virtual const"> + <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" /> @@ -34,18 +32,18 @@ <argument index="4" name="color" type="Color" /> <description> Draws box displaying character hexadecimal code. Used for replacing missing characters. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_font_clear_glyphs" qualifiers="virtual"> + <method name="font_clear_glyphs" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <description> Removes all rendered glyphs information from the cache entry. - [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. </description> </method> - <method name="_font_clear_kerning_map" qualifiers="virtual"> + <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" /> @@ -53,23 +51,22 @@ Removes all kerning overrides. </description> </method> - <method name="_font_clear_size_cache" qualifiers="virtual"> + <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 + Removes all font sizes from the cache entry. </description> </method> - <method name="_font_clear_textures" qualifiers="virtual"> + <method name="font_clear_textures" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <description> Removes all textures from font cache entry. - [b]Note:[/b] This function will not remove glyphs associated with the texture, use [method _font_remove_glyph] to remove them manually. </description> </method> - <method name="_font_draw_glyph" qualifiers="virtual const"> + <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" /> @@ -79,10 +76,9 @@ <argument index="5" name="color" type="Color" /> <description> Draws single glyph into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. </description> </method> - <method name="_font_draw_glyph_outline" qualifiers="virtual const"> + <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" /> @@ -93,10 +89,9 @@ <argument index="6" name="color" type="Color" /> <description> Draws single glyph outline of size [code]outline_size[/code] into a canvas item at the position, using [code]font_rid[/code] at the size [code]size[/code]. - [b]Note:[/b] Glyph index is specific to the font, use glyphs indices returned by [method _shaped_text_get_glyphs] or [method _font_get_glyph_index]. </description> </method> - <method name="_font_get_ascent" qualifiers="virtual const"> + <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" /> @@ -104,7 +99,7 @@ Returns the font ascent (number of pixels above the baseline). </description> </method> - <method name="_font_get_descent" qualifiers="virtual const"> + <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" /> @@ -112,37 +107,36 @@ Returns the font descent (number of pixels below the baseline). </description> </method> - <method name="_font_get_embolden" qualifiers="virtual const"> + <method name="font_get_embolden" qualifiers="virtual const"> <return type="float" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font embolden strength. </description> </method> - <method name="_font_get_fixed_size" qualifiers="virtual const"> + <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"> + <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"> + <method name="font_get_glyph_advance" qualifiers="virtual const"> <return type="Vector2" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="int" /> <argument index="2" name="glyph" type="int" /> <description> Returns glyph advance (offset of the next glyph). - [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> - <method name="_font_get_glyph_contours" qualifiers="virtual const"> + <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" /> @@ -154,7 +148,7 @@ [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"> + <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" /> @@ -164,7 +158,7 @@ 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"> + <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" /> @@ -172,7 +166,7 @@ Returns list of rendered glyphs in the cache entry. </description> </method> - <method name="_font_get_glyph_offset" qualifiers="virtual const"> + <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" /> @@ -181,7 +175,7 @@ Returns glyph offset from the baseline. </description> </method> - <method name="_font_get_glyph_size" qualifiers="virtual const"> + <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" /> @@ -190,7 +184,7 @@ Returns size of the glyph. </description> </method> - <method name="_font_get_glyph_texture_idx" qualifiers="virtual const"> + <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" /> @@ -199,7 +193,7 @@ Returns index of the cache texture containing the glyph. </description> </method> - <method name="_font_get_glyph_uv_rect" qualifiers="virtual const"> + <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" /> @@ -208,14 +202,14 @@ Returns rectangle in the cache texture containing the glyph. </description> </method> - <method name="_font_get_hinting" qualifiers="virtual const"> + <method name="font_get_hinting" qualifiers="virtual const"> <return type="int" enum="TextServer.Hinting" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns the font hinting mode. Used by dynamic fonts only. </description> </method> - <method name="_font_get_kerning" qualifiers="virtual const"> + <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" /> @@ -224,7 +218,7 @@ Returns kerning for the pair of glyphs. </description> </method> - <method name="_font_get_kerning_list" qualifiers="virtual const"> + <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" /> @@ -232,7 +226,7 @@ Returns list of the kerning overrides. </description> </method> - <method name="_font_get_language_support_override" qualifiers="virtual"> + <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" /> @@ -240,49 +234,49 @@ 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"> + <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"> + <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. + Returns 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"> + <method name="font_get_msdf_size" qualifiers="virtual const"> <return type="int" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns source font size used to generate MSDF textures. </description> </method> - <method name="_font_get_name" qualifiers="virtual const"> + <method name="font_get_name" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font family name. </description> </method> - <method name="_font_get_opentype_feature_overrides" qualifiers="virtual const"> + <method name="font_get_opentype_feature_overrides" qualifiers="virtual const"> <return type="Dictionary" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font OpenType feature set override. </description> </method> - <method name="_font_get_oversampling" qualifiers="virtual const"> + <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"> + <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" /> @@ -290,7 +284,7 @@ Returns scaling factor of the color bitmap font. </description> </method> - <method name="_font_get_script_support_override" qualifiers="virtual"> + <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" /> @@ -298,21 +292,21 @@ 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"> + <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"> + <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. + Returns 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"> + <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" /> @@ -321,35 +315,35 @@ Returns extra spacing added between glyphs in pixels. </description> </method> - <method name="_font_get_style" qualifiers="virtual const"> + <method name="font_get_style" qualifiers="virtual const"> <return type="int" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font style flags, see [enum TextServer.FontStyle]. </description> </method> - <method name="_font_get_style_name" qualifiers="virtual const"> + <method name="font_get_style_name" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font style name. </description> </method> - <method name="_font_get_subpixel_positioning" qualifiers="virtual const"> + <method name="font_get_subpixel_positioning" qualifiers="virtual const"> <return type="int" enum="TextServer.SubpixelPositioning" /> <argument index="0" name="font_rid" type="RID" /> <description> Returns font sub-pixel glyph positioning mode. </description> </method> - <method name="_font_get_supported_chars" qualifiers="virtual const"> + <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"> + <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" /> @@ -357,7 +351,7 @@ Returns number of textures used by font cache entry. </description> </method> - <method name="_font_get_texture_image" qualifiers="virtual const"> + <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" /> @@ -366,7 +360,7 @@ Returns font cache texture image data. </description> </method> - <method name="_font_get_texture_offsets" qualifiers="virtual const"> + <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" /> @@ -375,14 +369,14 @@ 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_transform" qualifiers="virtual const"> + <method name="font_get_transform" qualifiers="virtual const"> <return type="Transform2D" /> <argument index="0" name="font_rid" type="RID" /> <description> Retruns 2D transform applied to the font outlines. </description> </method> - <method name="_font_get_underline_position" qualifiers="virtual const"> + <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" /> @@ -390,7 +384,7 @@ Returns pixel offset of the underline below the baseline. </description> </method> - <method name="_font_get_underline_thickness" qualifiers="virtual const"> + <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" /> @@ -398,36 +392,36 @@ Returns thickness of the underline in pixels. </description> </method> - <method name="_font_get_variation_coordinates" qualifiers="virtual const"> + <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. + 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"> + <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. + Returns [code]true[/code] if a Unicode [code]char[/code] is available in the font. </description> </method> - <method name="_font_is_antialiased" qualifiers="virtual const"> + <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"> + <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 preferred over font built-in hinting. Used by dynamic fonts only. </description> </method> - <method name="_font_is_language_supported" qualifiers="virtual const"> + <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" /> @@ -435,14 +429,14 @@ 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"> + <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"> + <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" /> @@ -450,17 +444,16 @@ Returns [code]true[/code], if font supports given script (ISO 15924 code). </description> </method> - <method name="_font_remove_glyph" qualifiers="virtual"> + <method name="font_remove_glyph" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="glyph" type="int" /> <description> Removes specified rendered glyph information from the cache entry. - [b]Note:[/b] This function will not remove textures associated with the glyphs, use [method _font_remove_texture] to remove them manually. </description> </method> - <method name="_font_remove_kerning" qualifiers="virtual"> + <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" /> @@ -469,7 +462,7 @@ Removes kerning override for the pair of glyphs. </description> </method> - <method name="_font_remove_language_support_override" qualifiers="virtual"> + <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" /> @@ -477,7 +470,7 @@ Remove language support override. </description> </method> - <method name="_font_remove_script_support_override" qualifiers="virtual"> + <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" /> @@ -485,7 +478,7 @@ Removes script support override. </description> </method> - <method name="_font_remove_size_cache" qualifiers="virtual"> + <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" /> @@ -493,26 +486,25 @@ Removes specified font size from the cache entry. </description> </method> - <method name="_font_remove_texture" qualifiers="virtual"> + <method name="font_remove_texture" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="size" type="Vector2i" /> <argument index="2" name="texture_index" type="int" /> <description> Removes specified texture from font cache entry. - [b]Note:[/b] This function will not remove glyphs associated with the texture, remove them manually, using [method _font_remove_glyph]. </description> </method> - <method name="_font_render_glyph" qualifiers="virtual"> + <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. + Renders specified glyph to the font cache texture. </description> </method> - <method name="_font_render_range" qualifiers="virtual"> + <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" /> @@ -522,7 +514,7 @@ Renders the range of characters to the font cache texture. </description> </method> - <method name="_font_set_antialiased" qualifiers="virtual"> + <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" /> @@ -530,7 +522,7 @@ 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"> + <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" /> @@ -539,7 +531,7 @@ Sets the font ascent (number of pixels above the baseline). </description> </method> - <method name="_font_set_data" qualifiers="virtual"> + <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" /> @@ -547,25 +539,25 @@ Sets font source data, e.g contents of the dynamic font source file. </description> </method> - <method name="_font_set_data_ptr" qualifiers="virtual"> + <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). + Sets font source data, e.g contents of the dynamic font source file. [code]data_ptr[/code] memory buffer must remain accessible during font lifetime. </description> </method> - <method name="_font_set_descent" qualifiers="virtual"> + <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. + Sets the font descent (number of pixels below the baseline). </description> </method> - <method name="_font_set_embolden" qualifiers="virtual"> + <method name="font_set_embolden" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="strength" type="float" /> @@ -573,15 +565,15 @@ Sets font embolden strength. If [code]strength[/code] is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness. </description> </method> - <method name="_font_set_fixed_size" qualifiers="virtual"> + <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 preferred over font built-in hinting. + 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_force_autohinter" qualifiers="virtual"> + <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" /> @@ -589,7 +581,7 @@ If set to [code]true[/code] auto-hinting is preferred over font built-in hinting. </description> </method> - <method name="_font_set_global_oversampling" qualifiers="virtual"> + <method name="font_set_global_oversampling" qualifiers="virtual"> <return type="void" /> <argument index="0" name="oversampling" type="float" /> <description> @@ -597,7 +589,7 @@ [b]Note:[/b] This value can be automatically changed by display server. </description> </method> - <method name="_font_set_glyph_advance" qualifiers="virtual"> + <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" /> @@ -605,10 +597,9 @@ <argument index="3" name="advance" type="Vector2" /> <description> Sets glyph advance (offset of the next glyph). - [b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved. </description> </method> - <method name="_font_set_glyph_offset" qualifiers="virtual"> + <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" /> @@ -618,7 +609,7 @@ Sets glyph offset from the baseline. </description> </method> - <method name="_font_set_glyph_size" qualifiers="virtual"> + <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" /> @@ -628,7 +619,7 @@ Sets size of the glyph. </description> </method> - <method name="_font_set_glyph_texture_idx" qualifiers="virtual"> + <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" /> @@ -638,7 +629,7 @@ Sets index of the cache texture containing the glyph. </description> </method> - <method name="_font_set_glyph_uv_rect" qualifiers="virtual"> + <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" /> @@ -648,7 +639,7 @@ Sets rectangle in the cache texture containing the glyph. </description> </method> - <method name="_font_set_hinting" qualifiers="virtual"> + <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" /> @@ -656,7 +647,7 @@ Sets font hinting mode. Used by dynamic fonts only. </description> </method> - <method name="_font_set_kerning" qualifiers="virtual"> + <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" /> @@ -666,16 +657,16 @@ Sets kerning for the pair of glyphs. </description> </method> - <method name="_font_set_language_support_override" qualifiers="virtual"> + <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]. + Adds override for [method font_is_language_supported]. </description> </method> - <method name="_font_set_msdf_pixel_range" qualifiers="virtual"> + <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" /> @@ -683,7 +674,7 @@ 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"> + <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" /> @@ -691,15 +682,16 @@ Sets source font size used to generate MSDF textures. </description> </method> - <method name="_font_set_multichannel_signed_distance_field" qualifiers="virtual"> + <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. + 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. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes. + [b]Note:[/b] MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts. </description> </method> - <method name="_font_set_name" qualifiers="virtual"> + <method name="font_set_name" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="name" type="String" /> @@ -707,7 +699,7 @@ Sets the font family name. </description> </method> - <method name="_font_set_opentype_feature_overrides" qualifiers="virtual"> + <method name="font_set_opentype_feature_overrides" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="overrides" type="Dictionary" /> @@ -715,7 +707,7 @@ Sets font OpenType feature set override. </description> </method> - <method name="_font_set_oversampling" qualifiers="virtual"> + <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" /> @@ -723,7 +715,7 @@ 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"> + <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" /> @@ -732,16 +724,16 @@ Sets scaling factor of the color bitmap font. </description> </method> - <method name="_font_set_script_support_override" qualifiers="virtual"> + <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]. + Adds override for [method font_is_script_supported]. </description> </method> - <method name="_font_set_spacing" qualifiers="virtual"> + <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" /> @@ -751,7 +743,7 @@ Sets extra spacing added between glyphs in pixels. </description> </method> - <method name="_font_set_style" qualifiers="virtual"> + <method name="font_set_style" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="style" type="int" /> @@ -759,7 +751,7 @@ Sets the font style flags, see [enum TextServer.FontStyle]. </description> </method> - <method name="_font_set_style_name" qualifiers="virtual"> + <method name="font_set_style_name" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="name_style" type="String" /> @@ -767,7 +759,7 @@ Sets the font style name. </description> </method> - <method name="_font_set_subpixel_positioning" qualifiers="virtual"> + <method name="font_set_subpixel_positioning" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="subpixel_positioning" type="int" enum="TextServer.SubpixelPositioning" /> @@ -775,7 +767,7 @@ Sets font sub-pixel glyph positioning mode. </description> </method> - <method name="_font_set_texture_image" qualifiers="virtual"> + <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" /> @@ -785,7 +777,7 @@ Sets font cache texture image data. </description> </method> - <method name="_font_set_texture_offsets" qualifiers="virtual"> + <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" /> @@ -795,7 +787,7 @@ 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_transform" qualifiers="virtual"> + <method name="font_set_transform" qualifiers="virtual"> <return type="void" /> <argument index="0" name="font_rid" type="RID" /> <argument index="1" name="transform" type="Transform2D" /> @@ -804,7 +796,7 @@ For example, to simulate italic typeface by slanting, apply the following transform [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code]. </description> </method> - <method name="_font_set_underline_position" qualifiers="virtual"> + <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" /> @@ -813,7 +805,7 @@ Sets pixel offset of the underline below the baseline. </description> </method> - <method name="_font_set_underline_thickness" qualifiers="virtual"> + <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" /> @@ -822,29 +814,29 @@ Sets thickness of the underline in pixels. </description> </method> - <method name="_font_set_variation_coordinates" qualifiers="virtual"> + <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. + 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"> + <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"> + <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"> + <method name="format_number" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="string" type="String" /> <argument index="1" name="language" type="String" /> @@ -852,82 +844,82 @@ 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"> + <method name="free_rid" 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"> + <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"> + <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). + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_get_name" qualifiers="virtual const"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <method name="load_support_data" qualifiers="virtual"> <return type="bool" /> <argument index="0" name="filename" type="String" /> <description> Loads optional TextServer database (e.g. ICU break iterators and dictionaries). - [b]Note:[/b] This function should be called before any other TextServer functions used, otherwise it won't have any effect. </description> </method> - <method name="_name_to_tag" qualifiers="virtual const"> + <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"> + <method name="parse_number" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="string" type="String" /> <argument index="1" name="language" type="String" /> @@ -935,14 +927,14 @@ 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"> + <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"> + <method name="save_support_data" qualifiers="virtual const"> <return type="bool" /> <argument index="0" name="filename" type="String" /> <description> @@ -950,14 +942,14 @@ [b]Note:[/b] This function is used by during project export, to include TextServer database. </description> </method> - <method name="_shaped_get_span_count" qualifiers="virtual const"> + <method name="shaped_get_span_count" qualifiers="virtual const"> <return type="int" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns number of text spans added using [method _shaped_text_add_string] or [method _shaped_text_add_object]. + Returns number of text spans added using [method shaped_text_add_string] or [method shaped_text_add_object]. </description> </method> - <method name="_shaped_get_span_meta" qualifiers="virtual const"> + <method name="shaped_get_span_meta" qualifiers="virtual const"> <return type="Variant" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="index" type="int" /> @@ -965,7 +957,7 @@ Returns text span metadata. </description> </method> - <method name="_shaped_set_span_update_font" qualifiers="virtual"> + <method name="shaped_set_span_update_font" qualifiers="virtual"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="index" type="int" /> @@ -976,7 +968,7 @@ Changes text span font, font size and OpenType features, without changing the text. </description> </method> - <method name="_shaped_text_add_object" qualifiers="virtual"> + <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" /> @@ -987,7 +979,7 @@ 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"> + <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" /> @@ -1000,14 +992,14 @@ Adds text span and font to draw it to the text buffer. </description> </method> - <method name="_shaped_text_clear" qualifiers="virtual"> + <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"> + <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" /> @@ -1017,9 +1009,10 @@ <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). + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_draw_outline" qualifiers="virtual const"> + <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" /> @@ -1030,116 +1023,118 @@ <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). + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_fit_to_width" qualifiers="virtual"> + <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 + Adjusts text with to fit to specified width, returns new text width. </description> </method> - <method name="_shaped_text_get_ascent" qualifiers="virtual const"> + <method name="shaped_text_get_ascent" qualifiers="virtual const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> <description> Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). - [b]Note:[/b] Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline. </description> </method> - <method name="_shaped_text_get_carets" qualifiers="virtual const"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_custom_punctuation" qualifiers="virtual const"> + <method name="shaped_text_get_custom_punctuation" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="shaped" type="RID" /> <description> Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> - <method name="_shaped_text_get_descent" qualifiers="virtual const"> + <method name="shaped_text_get_descent" qualifiers="virtual const"> <return type="float" /> <argument index="0" name="shaped" type="RID" /> <description> Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). - [b]Note:[/b] Overall descent can be higher than font descent, if some glyphs are displaced from the baseline. </description> </method> - <method name="_shaped_text_get_direction" qualifiers="virtual const"> + <method name="shaped_text_get_direction" qualifiers="virtual const"> <return type="int" enum="TextServer.Direction" /> <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"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_ellipsis_glyph_count" qualifiers="virtual const"> + <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="Glyph*" /> + <method name="shaped_text_get_ellipsis_glyphs" qualifiers="virtual const"> + <return type="const Glyph*" /> <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="virtual const"> + <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"> + <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. + Returns number of glyphs in the buffer. </description> </method> - <method name="_shaped_text_get_glyphs" qualifiers="virtual const"> - <return type="Glyph*" /> + <method name="shaped_text_get_glyphs" qualifiers="virtual const"> + <return type="const Glyph*" /> <argument index="0" name="shaped" type="RID" /> <description> - Copies text glyphs in the visual order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + Returns an array of glyphs in the visual order. </description> </method> - <method name="_shaped_text_get_grapheme_bounds" qualifiers="virtual const"> + <method name="shaped_text_get_grapheme_bounds" qualifiers="virtual const"> <return type="Vector2" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="pos" type="int" /> <description> Returns composite character's bounds as offsets from the start of the line. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_inferred_direction" qualifiers="virtual const"> + <method name="shaped_text_get_inferred_direction" qualifiers="virtual const"> <return type="int" enum="TextServer.Direction" /> <argument index="0" name="shaped" type="RID" /> <description> Returns direction of the text, inferred by the BiDi algorithm. </description> </method> - <method name="_shaped_text_get_line_breaks" qualifiers="virtual const"> + <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" /> @@ -1147,9 +1142,10 @@ <argument index="3" name="break_flags" type="int" /> <description> Breaks text to the lines and returns character ranges for each line. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_line_breaks_adv" qualifiers="virtual const"> + <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" /> @@ -1158,9 +1154,10 @@ <argument index="4" name="break_flags" type="int" /> <description> Breaks text to the lines and columns. Returns character ranges for each segment. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_object_rect" qualifiers="virtual const"> + <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" /> @@ -1168,35 +1165,35 @@ Returns bounding rectangle of the inline object. </description> </method> - <method name="_shaped_text_get_objects" qualifiers="virtual const"> + <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"> + <method name="shaped_text_get_orientation" qualifiers="virtual const"> <return type="int" enum="TextServer.Orientation" /> <argument index="0" name="shaped" type="RID" /> <description> - Returns text orientation. + eturns text orientation. </description> </method> - <method name="_shaped_text_get_parent" qualifiers="virtual const"> + <method name="shaped_text_get_parent" qualifiers="virtual const"> <return type="RID" /> <argument index="0" name="shaped" type="RID" /> <description> - Sets text orientation. + Returns the parent buffer from which the substring originates. </description> </method> - <method name="_shaped_text_get_preserve_control" qualifiers="virtual const"> + <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"> + <method name="shaped_text_get_preserve_invalid" qualifiers="virtual const"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> <description> @@ -1204,97 +1201,102 @@ [b]Note:[/b] If set to [code]false[/code], nothing is displayed in place of invalid characters. </description> </method> - <method name="_shaped_text_get_range" qualifiers="virtual const"> + <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"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_get_size" qualifiers="virtual const"> + <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"> + <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. + Returns the position of the overrun trim. </description> </method> - <method name="_shaped_text_get_underline_position" qualifiers="virtual const"> + <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"> + <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"> + <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"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_hit_test_grapheme" qualifiers="virtual const"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_hit_test_position" qualifiers="virtual const"> + <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. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_is_ready" qualifiers="virtual const"> + <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"> + <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]. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_overrun_trim_to_width" qualifiers="virtual"> + <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" /> @@ -1303,15 +1305,16 @@ Trims text if it exceeds the given width. </description> </method> - <method name="_shaped_text_prev_grapheme_pos" qualifiers="virtual const"> + <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]. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_shaped_text_resize_object" qualifiers="virtual"> + <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" /> @@ -1321,7 +1324,7 @@ Sets new size and alignment of embedded object. </description> </method> - <method name="_shaped_text_set_bidi_override" qualifiers="virtual"> + <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" /> @@ -1330,7 +1333,7 @@ Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. </description> </method> - <method name="_shaped_text_set_custom_punctuation" qualifiers="virtual"> + <method name="shaped_text_set_custom_punctuation" qualifiers="virtual"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="punct" type="String" /> @@ -1338,25 +1341,23 @@ Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used. </description> </method> - <method name="_shaped_text_set_direction" qualifiers="virtual"> + <method name="shaped_text_set_direction" qualifiers="virtual"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="direction" type="int" enum="TextServer.Direction" /> <description> Sets desired text direction. If set to [code]TEXT_DIRECTION_AUTO[/code], direction will be detected based on the buffer contents and current locale. - [b]Note:[/b] Direction is ignored if server does not support [code]FEATURE_BIDI_LAYOUT[/code] feature. </description> </method> - <method name="_shaped_text_set_orientation" qualifiers="virtual"> + <method name="shaped_text_set_orientation" qualifiers="virtual"> <return type="void" /> <argument index="0" name="shaped" type="RID" /> <argument index="1" name="orientation" type="int" enum="TextServer.Orientation" /> <description> Sets desired text orientation. - [b]Note:[/b] Orientation is ignored if server does not support [code]FEATURE_VERTICAL_LAYOUT[/code] feature. </description> </method> - <method name="_shaped_text_set_preserve_control" qualifiers="virtual"> + <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" /> @@ -1364,7 +1365,7 @@ If set to [code]true[/code] text buffer will display control characters. </description> </method> - <method name="_shaped_text_set_preserve_invalid" qualifiers="virtual"> + <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" /> @@ -1372,22 +1373,21 @@ 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"> + <method name="shaped_text_shape" qualifiers="virtual"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> <description> Shapes buffer if it's not shaped. Returns [code]true[/code] if the string is shaped successfully. - [b]Note:[/b] It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested. </description> </method> - <method name="_shaped_text_sort_logical" qualifiers="virtual"> - <return type="Glyph*" /> + <method name="shaped_text_sort_logical" qualifiers="virtual"> + <return type="const Glyph*" /> <argument index="0" name="shaped" type="RID" /> <description> - Copies text glyphs in the logical order, into preallocated array of the size returned by [method _shaped_text_get_glyph_count]. + Returns text glyphs in the logical order. </description> </method> - <method name="_shaped_text_substr" qualifiers="virtual const"> + <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" /> @@ -1396,7 +1396,7 @@ 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"> + <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" /> @@ -1404,37 +1404,47 @@ Aligns shaped text to the given tab-stops. </description> </method> - <method name="_shaped_text_update_breaks" qualifiers="virtual"> + <method name="shaped_text_update_breaks" qualifiers="virtual"> <return type="bool" /> <argument index="0" name="shaped" type="RID" /> <description> - Updates line and word breaks. + Updates line breaking positions in the text buffer. + [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. </description> </method> - <method name="_shaped_text_update_justification_ops" qualifiers="virtual"> + <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.). + Updates line justification positions (word breaks and elongations) in the text buffer. + [b]Note:[/b] This method is used by default line/word breaking methods, and its implementation might be omitted if custom line breaking in implemented. </description> </method> - <method name="_string_to_lower" qualifiers="virtual const"> + <method name="string_to_lower" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="string" type="String" /> <argument index="1" name="language" type="String" /> <description> - Returns the string converted to lowercase. Casing is locale dependent and context sensitive. The result may be longer or shorter than the original. + Returns the string converted to lowercase. </description> </method> - <method name="_string_to_upper" qualifiers="virtual const"> + <method name="string_to_upper" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="string" type="String" /> <argument index="1" name="language" type="String" /> <description> - Returns the string converted to uppercase. Casing is locale dependent and context sensitive. The result may be longer or shorter than the original. + Returns the string converted to uppercase. + </description> + </method> + <method name="strip_diacritics" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="string" type="String" /> + <description> + Strips diacritics from the string. + [b]Note:[/b] If this method is not implemented in the plugin, the default implementation will be used. </description> </method> - <method name="_tag_to_name" qualifiers="virtual const"> + <method name="tag_to_name" qualifiers="virtual const"> <return type="String" /> <argument index="0" name="tag" type="int" /> <description> |