seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document RichTextLabel fgcolor and bgcolor padding behavior (and risk of overlap)

Browse Source
This commit is contained in:
Hugo Locurcio
2025-03-17 19:53:24 +01:00
parent 9e6ee9c5c3
commit 0b4cda7db3
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/RichTextLabel.xml
View File

@ -341,6 +341,7 @@
<param index="0" name="bgcolor" type="Color" />
<description>
Adds a [code skip-lint][bgcolor][/code] tag to the tag stack.
[b]Note:[/b] The background color has padding applied by default, which is controlled using [theme_item text_highlight_h_padding] and [theme_item text_highlight_v_padding]. This can lead to overlapping highlights if background colors are placed on neighboring lines/columns, so consider setting those theme items to [code]0[/code] if you want to avoid this.
</description>
</method>
<method name="push_bold">
@ -400,6 +401,7 @@
<param index="0" name="fgcolor" type="Color" />
<description>
Adds a [code skip-lint][fgcolor][/code] tag to the tag stack.
[b]Note:[/b] The foreground color has padding applied by default, which is controlled using [theme_item text_highlight_h_padding] and [theme_item text_highlight_v_padding]. This can lead to overlapping highlights if foreground colors are placed on neighboring lines/columns, so consider setting those theme items to [code]0[/code] if you want to avoid this.
</description>
</method>
<method name="push_font">
@ -861,10 +863,10 @@
The vertical separation of elements in a table.
</theme_item>
<theme_item name="text_highlight_h_padding" data_type="constant" type="int" default="3">
The horizontal padding around boxes drawn by the [code][fgcolor][/code] and [code][bgcolor][/code] tags. This does not affect the appearance of text selection.
The horizontal padding around boxes drawn by the [code][fgcolor][/code] and [code][bgcolor][/code] tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to [code]0[/code] to disable padding.
</theme_item>
<theme_item name="text_highlight_v_padding" data_type="constant" type="int" default="3">
The vertical padding around boxes drawn by the [code][fgcolor][/code] and [code][bgcolor][/code] tags. This does not affect the appearance of text selection.
The vertical padding around boxes drawn by the [code][fgcolor][/code] and [code][bgcolor][/code] tags. This does not affect the appearance of text selection. To avoid any risk of neighboring highlights overlapping each other, set this to [code]0[/code] to disable padding.
</theme_item>
<theme_item name="bold_font" data_type="font" type="Font">
The font used for bold text.