Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Improve RichTextLabel install_effect() documentation

Browse Source
This commit is contained in:
Hugo Locurcio 2023-12-19 17:29:49 +01:00
parent 1f5d4a62e9
commit 78fff7292c
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/RichTextEffect.xml
View File

@ -4,7 +4,7 @@
A custom effect for a [RichTextLabel].
</brief_description>
<description>
A custom effect for a [RichTextLabel].
A custom effect for a [RichTextLabel], which can be loaded in the [RichTextLabel] inspector or using [method RichTextLabel.install_effect].
[b]Note:[/b] For a [RichTextEffect] to be usable, a BBCode tag must be defined as a member variable called [code]bbcode[/code] in the script.
[codeblocks]
[gdscript skip-lint]

23
doc/classes/RichTextLabel.xml
View File

@ -225,7 +225,28 @@
<return type="void" />
<param index="0" name="effect" type="Variant" />
<description>
Installs a custom effect. [param effect] should be a valid [RichTextEffect].
Installs a custom effect. This can also be done in the RichTextLabel inspector using the [member custom_effects] property. [param effect] should be a valid [RichTextEffect].
Example RichTextEffect:
[codeblock]
# effect.gd
class_name MyCustomEffect
extends RichTextEffect
var bbcode = "my_custom_effect"
# ...
[/codeblock]
Registering the above effect in RichTextLabel from script:
[codeblock]
# rich_text_label.gd
extends RichTextLabel
func _ready():
install_effect(MyCustomEffect.new())
# Alternatively, if not using `class_name` in the script that extends RichTextEffect:
install_effect(preload("res://effect.gd").new())
[/codeblock]
</description>
</method>
<method name="is_menu_visible" qualifiers="const">