Browse Source

Warn about the importance of registering the RichTextEffect

Hugo Locurcio 3 years ago
parent
commit
23dd5d21ae
1 changed files with 6 additions and 0 deletions
  1. 6 0
      tutorials/ui/bbcode_in_richtextlabel.rst

+ 6 - 0
tutorials/ui/bbcode_in_richtextlabel.rst

@@ -565,6 +565,12 @@ nor does it need to be running in ``tool`` mode. The new effect can be registere
 the Inspector by adding it to the **Custom Effects** array, or in code with the
 the Inspector by adding it to the **Custom Effects** array, or in code with the
 :ref:`install_effect() <class_RichTextLabel_method_install_effect>` method.
 :ref:`install_effect() <class_RichTextLabel_method_install_effect>` method.
 
 
+.. 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)``.
 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
 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
 name ``bbcode``. The code will check the ``bbcode`` property automatically or will