summaryrefslogtreecommitdiff
path: root/doc/classes/RichTextLabel.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/RichTextLabel.xml')
-rw-r--r--doc/classes/RichTextLabel.xml27
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml
index 5f07133a27..c44df72878 100644
--- a/doc/classes/RichTextLabel.xml
+++ b/doc/classes/RichTextLabel.xml
@@ -20,8 +20,10 @@
</argument>
<argument index="2" name="height" type="int" default="0">
</argument>
+ <argument index="3" name="color" type="Color" default="Color( 1, 1, 1, 1 )">
+ </argument>
<description>
- Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image.
+ Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image and a [code]color[/code] to tint the image.
If [code]width[/code] or [code]height[/code] is set to 0, the image size will be adjusted in order to keep the original aspect ratio.
</description>
</method>
@@ -50,7 +52,7 @@
Clears the tag stack and sets [member bbcode_text] to an empty string.
</description>
</method>
- <method name="get_content_height">
+ <method name="get_content_height" qualifiers="const">
<return type="int">
</return>
<description>
@@ -292,6 +294,10 @@
The currently installed custom effects. This is an array of [RichTextEffect]s.
To add a custom effect, it's more convenient to use [method install_effect].
</member>
+ <member name="fit_content_height" type="bool" setter="set_fit_content_height" getter="is_fit_content_height_enabled" default="false">
+ 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="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined" default="true">
If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code].
</member>
@@ -409,38 +415,55 @@
</constants>
<theme_items>
<theme_item name="bold_font" type="Font">
+ The font used for bold text.
</theme_item>
<theme_item name="bold_italics_font" type="Font">
+ The font used for bold italics text.
</theme_item>
<theme_item name="default_color" type="Color" default="Color( 1, 1, 1, 1 )">
+ The default text color.
</theme_item>
<theme_item name="focus" type="StyleBox">
+ The background The background used when the [RichTextLabel] is focused.
</theme_item>
<theme_item name="font_color_selected" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )">
+ The color of selected text, used when [member selection_enabled] is [code]true[/code].
</theme_item>
<theme_item name="font_color_shadow" type="Color" default="Color( 0, 0, 0, 0 )">
+ The color of the font's shadow.
</theme_item>
<theme_item name="italics_font" type="Font">
+ The font used for italics text.
</theme_item>
<theme_item name="line_separation" type="int" default="1">
+ The vertical space between lines.
</theme_item>
<theme_item name="mono_font" type="Font">
+ The font used for monospace text.
</theme_item>
<theme_item name="normal" type="StyleBox">
+ The normal background for the [RichTextLabel].
</theme_item>
<theme_item name="normal_font" type="Font">
+ The default text font.
</theme_item>
<theme_item name="selection_color" type="Color" default="Color( 0.1, 0.1, 1, 0.8 )">
+ The color of the selection box.
</theme_item>
<theme_item name="shadow_as_outline" type="int" default="0">
+ Boolean value. If 1 ([code]true[/code]), the shadow will be displayed around the whole text as an outline.
</theme_item>
<theme_item name="shadow_offset_x" type="int" default="1">
+ The horizontal offset of the font's shadow.
</theme_item>
<theme_item name="shadow_offset_y" type="int" default="1">
+ The vertical offset of the font's shadow.
</theme_item>
<theme_item name="table_hseparation" type="int" default="3">
+ The horizontal separation of elements in a table.
</theme_item>
<theme_item name="table_vseparation" type="int" default="3">
+ The vertical separation of elements in a table.
</theme_item>
</theme_items>
</class>