RichTextLabel's built-in effects are not exposed as push_() functions

[Calinou]

Godot version

4.0.2.stable

Issue description

I noticed something while working on #77117. These RichTextLabel methods exist in the C++ source code, but aren't exposed to GDScript unlike other built-in tags like push_bgcolor():

• push_fade()
• push_shake()
• push_wave()
• push_tornado()
• push_rainbow()

Having these methods exposed would be useful for consistency with other tags, but also because large text is faster to format using push_*() methods compared to BBCode.

Note that set_process_internal(true) is called in the BBCode handler for those tags (example), not in the push_*() methods (other than push_customfx() which is exposed). This call should be moved to the push_* methods so that it works even if you only use push_*() methods to format your RichTextLabel's text.

cc @Eoin-ONeill-Yokai – is there a reason these methods aren't exposed?

Keywords for easier searching: RichTextEffect

[Eoin-ONeill-Yokai]

It was probably a mistake on my part on the original MR -- I don't think there should be any problem with exposing the push functions to scripting language. And yes, the set_process_internal should be moved to accommodate.

I'll take a look tomorrow.

[akien-mga]

Isn't push_customfx enough? It's also suitable for script-defined custom fx, and the current list of the builtin ones is pretty arbitrary so I'm not sure they should be exposed as part of the API.

but also because large text is faster to format using push_*() methods compared to BBCode.

How so? Do you mean faster for the programmer, or more performant?

[Calinou]

push_customfx() works for custom effects, but there is no way to refer to the built-in effects I know of as you can't grab a handle on them from the scripting API.

How so? Do you mean faster for the programmer, or more performant?

It's more performant to use push_* methods, as well as more secure when BBCode is disabled to prevent any risk of formatting injection from untrusted input.

[Sociopathix]

Hi there, was this ever resolved? I am currently trying to use the built-in custom effects.

[Eoin-ONeill-Yokai]

Sorry, I've been a bit busy on my end but I should be able to address this sometime this week. Let me put it to the top of my Thursday tasks and I'll try to get it done as it shouldn't be too hard to do.

[Sociopathix]

No worries! I found a workaround but I do think a lot of things could be easier if we had these functions available. :]