godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Warn about the importance of registering the RichTextEffect

Browse Source 
(cherry picked from commit 23dd5d21ae)
This commit is contained in:
Hugo Locurcio
2022-08-15 11:17:27 +02:00
committed by Rémi Verschelde
parent d3477bfb40
commit ba6243e315
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tutorials/ui/bbcode_in_richtextlabel.rst
View File

@@ -223,6 +223,12 @@ within the editor itself. The RichTextLabel does not need to have a script attac
nor does it need to be running in ``tool`` mode. The new effect will be activable in
the Inspector through the **Custom Effects** property.
.. warning::
If the custom effect is not registered within the RichTextLabel's
**Custom Effects** property, no effect will be visible and the original
tag will be left as-is.
There is only one function that you need to extend: ``_process_custom_fx(char_fx)``.
Optionally, you can also provide a custom BBCode identifier simply by adding a member
name ``bbcode``. The code will check the ``bbcode`` property automatically or will