asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/Label.xml

152 lines
9.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add keywords to improve search in the class reference
2024-02-21 18:51:08 +01:00
<class name="Label" inherits="Control" keywords="text" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
A control for displaying plain text.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
A control for displaying plain text. It gives you control over the horizontal and vertical alignment and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics, or other rich text formatting. For that, use [RichTextLabel] instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Update links to outdated asset library demos Update links to outdated asset library demos Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
2024-03-25 02:20:59 +01:00
<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/2712</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
[Label] Add get_character_bounds method to get bounding rectangles of the characters.
2023-10-30 13:30:22 +01:00
<method name="get_character_bounds" qualifiers="const">
<return type="Rect2" />
<param index="0" name="pos" type="int" />
<description>
Returns the bounding rectangle of the character at position [param pos]. If the character is a non-visual character or [param pos] is outside the valid range, an empty [Rect2] is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-18 00:08:09 +02:00
Returns the number of lines of text the Label has.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_line_height" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="line" type="int" default="-1" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 15:36:48 +02:00
Returns the height of the line [param line].
If [param line] is set to [code]-1[/code], returns the biggest line height.
If there are no lines, returns font size in pixels.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_total_character_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Fix return value of get_total_character_count Also document that it only counts visible characters. Fixes #23720
2018-11-15 12:34:08 +01:00
Returns the total number of printable characters in the text (excluding spaces and newlines).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_visible_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns the number of lines shown. Useful if the [Label]'s height cannot currently display all lines.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 10:01:45 +02:00
<member name="autowrap_mode" type="int" setter="set_autowrap_mode" getter="get_autowrap_mode" enum="TextServer.AutowrapMode" default="0">
If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see [enum TextServer.AutowrapMode].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="clip_text" type="bool" setter="set_clip_text" getter="is_clipping_text" default="false">
Amend `Label`.clip_text() Method Description This update fixes an inconsistencies in the documentation about the `clip_text()` method.
2021-06-26 05:33:00 +02:00
If [code]true[/code], the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
[Text Overrun] Add option to set custom ellipsis character, add support for system font fallback.
2023-10-01 12:39:13 +02:00
<member name="ellipsis_char" type="String" setter="set_ellipsis_char" getter="get_ellipsis_char" default="&quot;…&quot;">
Ellipsis character used for text clipping.
</member>
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 03:58:47 +01:00
<member name="horizontal_alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants.
</member>
Display `BitField[Enum]` in docs to distinguish from `Enum`
2023-06-15 16:06:22 +02:00
<member name="justification_flags" type="int" setter="set_justification_flags" getter="get_justification_flags" enum="TextServer.JustificationFlag" is_bitfield="true" default="163">
[RTL] Expose missing default properties, ensure bbcode is reparserd when these are changed.
2024-07-16 10:36:17 +02:00
Line fill alignment rules. See [enum TextServer.JustificationFlag] for more information.
Expose TextServer justification flags to Label, Label3D, TextMesh and RTL. Add flags to control last/single line justification.
2023-03-23 10:22:37 +01:00
</member>
Add LabelSettings resource for quick Label theme property override.
2022-06-17 10:05:18 +02:00
<member name="label_settings" type="LabelSettings" setter="set_label_settings" getter="get_label_settings">
Fill random docs
2022-11-21 03:48:36 +01:00
A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties.
Add LabelSettings resource for quick Label theme property override.
2022-06-17 10:05:18 +02:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="lines_skipped" type="int" setter="set_lines_skipped" getter="get_lines_skipped" default="0">
Validate `code` tags for class and member references This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
2023-10-02 20:11:43 +02:00
The number of the lines ignored and not displayed from the start of the [member text] value.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="max_lines_visible" type="int" setter="set_max_lines_visible" getter="get_max_lines_visible" default="-1">
Write TextureRect, Label and NinePatchRect
2017-09-16 11:54:44 +02:00
Limits the lines of text the node shows on screen.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:38:49 +01:00
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="2" />
Display `BitField[Enum]` in docs to distinguish from `Enum`
2023-06-15 16:06:22 +02:00
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" enum="Control.SizeFlags" is_bitfield="true" default="4" />
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 12:27:18 +02:00
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
Set BiDi algorithm override for the structured text.
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
Set additional options for BiDi override.
</member>
[Label] Add support for tab stops.
2023-04-16 13:48:43 +02:00
<member name="tab_stops" type="PackedFloat32Array" setter="set_tab_stops" getter="get_tab_stops" default="PackedFloat32Array()">
Aligns text to the given tab-stops.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
Write TextureRect, Label and NinePatchRect
2017-09-16 11:54:44 +02:00
The text to display on screen.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0">
Base text writing direction.
</member>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 10:01:45 +02:00
<member name="text_overrun_behavior" type="int" setter="set_text_overrun_behavior" getter="get_text_overrun_behavior" enum="TextServer.OverrunBehavior" default="0">
Sets the clipping behavior when the text exceeds the node's bounding rectangle. See [enum TextServer.OverrunBehavior] for a description of all modes.
Improvements to Label's layout options - Added options to trim the text in case it overruns - Added more autowrap modes - Improved line breaking, which ignores trailing spaces
2021-07-04 16:43:55 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="uppercase" type="bool" setter="set_uppercase" getter="is_uppercase" default="false">
Write TextureRect, Label and NinePatchRect
2017-09-16 11:54:44 +02:00
If [code]true[/code], all the text displays as UPPERCASE.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 03:58:47 +01:00
<member name="vertical_alignment" type="int" setter="set_vertical_alignment" getter="get_vertical_alignment" enum="VerticalAlignment" default="0">
Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the [enum VerticalAlignment] constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1">
Improve `percent_visible` and `visible_characters` description Applies for Label and RichTextLabel.
2022-08-22 15:13:19 +02:00
The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box.
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-20 20:06:13 +02:00
[b]Note:[/b] Setting this property updates [member visible_ratio] accordingly.
Add different "visible characters" behavior modes.
2021-12-05 13:28:32 +01:00
</member>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 10:01:45 +02:00
<member name="visible_characters_behavior" type="int" setter="set_visible_characters_behavior" getter="get_visible_characters_behavior" enum="TextServer.VisibleCharactersBehavior" default="0">
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-20 20:06:13 +02:00
Sets the clipping behavior when [member visible_characters] or [member visible_ratio] is set. See [enum TextServer.VisibleCharactersBehavior] for more info.
</member>
<member name="visible_ratio" type="float" setter="set_visible_ratio" getter="get_visible_ratio" default="1.0">
The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.
[b]Note:[/b] Setting this property updates [member visible_characters] accordingly.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</members>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="font_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Document theme_items of multiple classes
2020-01-27 02:15:37 +01:00
Default text [Color] of the [Label].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Use black for font outlines by default instead of white This makes font outlines more usable out of the box, as black is one of the most commonly used colors for font outlines.
2021-11-05 20:50:01 +01:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)">
Fill random docs
2022-11-21 03:48:36 +01:00
The color of text outline.
Sync classref with current source
2018-05-12 09:38:00 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="font_shadow_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 14:11:45 +01:00
[Color] of the text's shadow effect.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="line_spacing" data_type="constant" type="int" default="3">
Document theme_items of multiple classes
2020-01-27 02:15:37 +01:00
Vertical space between lines in multiline [Label].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
Text outline size.
Document MDSF font outlines may require `msdf_pixel_range` adjustments
2022-12-19 17:15:44 +01:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Add note that a large value for outline_size is not recommended
2023-12-19 23:13:42 +01:00
[b]Note:[/b] Using a value that is larger than half the font size is not recommended, as the font outline may fail to be fully closed in this case.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="shadow_offset_x" data_type="constant" type="int" default="1">
Document theme_items of multiple classes
2020-01-27 02:15:37 +01:00
The horizontal offset of the text's shadow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="shadow_offset_y" data_type="constant" type="int" default="1">
Document theme_items of multiple classes
2020-01-27 02:15:37 +01:00
The vertical offset of the text's shadow.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="shadow_outline_size" data_type="constant" type="int" default="1">
Fix Label and RichTextLabale text shadows and shadow outlines.
2021-11-05 23:28:48 +01:00
The size of the shadow outline.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="font" data_type="font" type="Font">
[Font] used for the [Label]'s text.
</theme_item>
<theme_item name="font_size" data_type="font_size" type="int">
Font size of the [Label]'s text.
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
Background [StyleBox] for the [Label].
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_items>
</class>
Reference in a new issue Copy permalink