Skip to content

Commit 887c0cc

Browse files
authored
Merge pull request #10543 from havi05/bbcode_rainbow
Update `rainbow` bbcode options - add `speed`
2 parents e3986bf + 9161812 commit 887c0cc

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

tutorials/ui/bbcode_in_richtextlabel.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,12 +1015,13 @@ Rainbow
10151015
.. image:: img/bbcode_in_richtextlabel_effect_rainbow.webp
10161016

10171017
Rainbow gives the text a rainbow color that changes over time. Its tag format is
1018-
``[rainbow freq=1.0 sat=0.8 val=0.8]{text}[/rainbow]``.
1018+
``[rainbow freq=1.0 sat=0.8 val=0.8 speed=1.0]{text}[/rainbow]``.
10191019

1020-
``freq`` is the number of full rainbow cycles per second, ``sat`` is the
1021-
saturation of the rainbow, ``val`` is the value of the rainbow. A ``freq`` value
1022-
of ``0`` will pause the animation, while negative ``freq`` will play the
1023-
animation backwards.
1020+
``freq`` determines how many letters the rainbow extends over before it repeats itself,
1021+
``sat`` is the saturation of the rainbow, ``val`` is the value of the rainbow. ``speed``
1022+
is the number of full rainbow cycles per second. A positive ``speed`` value will play
1023+
the animation forwards, a value of ``0`` will pause the animation, and a negative
1024+
``speed`` value will play the animation backwards.
10241025

10251026
Font outlines are *not* affected by the rainbow effect (they keep their original color).
10261027
Existing font colors are overridden by the rainbow effect. However, CanvasItem's

0 commit comments

Comments
 (0)