Improve RichTextLabel `install_effect()` documentation
This commit is contained in:
parent
1f5d4a62e9
commit
78fff7292c
|
@ -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]
|
||||
|
|
|
@ -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">
|
||||
|
|
Loading…
Reference in New Issue