From 91618125d5076e4cb4906761c3d52c2d95620c25 Mon Sep 17 00:00:00 2001 From: havi05 Date: Wed, 22 Jan 2025 23:11:48 +0100 Subject: [PATCH] Update `rainbow` bbcode options - add `speed` --- tutorials/ui/bbcode_in_richtextlabel.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/tutorials/ui/bbcode_in_richtextlabel.rst b/tutorials/ui/bbcode_in_richtextlabel.rst index 82efe33e5..8b7041f9a 100644 --- a/tutorials/ui/bbcode_in_richtextlabel.rst +++ b/tutorials/ui/bbcode_in_richtextlabel.rst @@ -1015,12 +1015,13 @@ Rainbow .. image:: img/bbcode_in_richtextlabel_effect_rainbow.webp Rainbow gives the text a rainbow color that changes over time. Its tag format is -``[rainbow freq=1.0 sat=0.8 val=0.8]{text}[/rainbow]``. +``[rainbow freq=1.0 sat=0.8 val=0.8 speed=1.0]{text}[/rainbow]``. -``freq`` is the number of full rainbow cycles per second, ``sat`` is the -saturation of the rainbow, ``val`` is the value of the rainbow. A ``freq`` value -of ``0`` will pause the animation, while negative ``freq`` will play the -animation backwards. +``freq`` determines how many letters the rainbow extends over before it repeats itself, +``sat`` is the saturation of the rainbow, ``val`` is the value of the rainbow. ``speed`` +is the number of full rainbow cycles per second. A positive ``speed`` value will play +the animation forwards, a value of ``0`` will pause the animation, and a negative +``speed`` value will play the animation backwards. Font outlines are *not* affected by the rainbow effect (they keep their original color). Existing font colors are overridden by the rainbow effect. However, CanvasItem's