Skip to content

Animations and Modifiers

Niall7459 edited this page Jul 1, 2020 · 4 revisions

Animations and Modifiers

If you're looking for information on the Animations expansion, see the placeholder page

Notes:

  • All animations use their american counterpart spelling.
  • Some animations or their specific options require KiteBoard 3.2 running on a 1.16 server.

Skip to:

Animation format:

HTML Parser

<tag-name option1 option2=false, option3=&0>Animation text</tag-name>

All animation options use american spelling.

Align

This animation uses implicit boolean options. A true value is not required and will be inferred as long as the option name is present. (Introduced v3.1, May 2020)

Align left:

<align left width=32>Text aligned left</align>

Align right:

<align right width=32>Text aligned right</align>
Option Description Default
Width Width of container to align within. 32
Left Align left false
Right Align right false

Appear

Make text appear

<appear>Appearing text</appear>

With a fading effect:

<appear fade>Appearing text</appear>

Erase

Erase text

<erase>Erasing text</erase>

With a fading effect:

<erase fade>Erasing text</erase>

Flash

<flash>Flashing text</flash>

Fading text

Available variants:
This animation uses implicit boolean options. A true value is not required and will be inferred as long as the option name is present. (Introduced v3.1, May 2020)

Some options in this animation require KiteBoard 3.2 running on Minecraft 1.16 or above.

Option Description Default
in Fade from black to white false
out Fade from white to black false
from (3.2/1.16+ only) Specify fade from colour #000000
to (3.2/1.16+ only) Specify fade to colour #FFFFFF
hsb (3.2/1.16+ only) Use HSB colour interpolation for fading gradient false
length (3.2/1.16+ only) Amount of frames to generate for the fade 10

Fading from Red to Blue (3.2/1.16+ only)

<fade from=#FF0000 to=#0000FF>Fade from red to blue</fade>

Fade in:

<fade in>Text fading in</fade>

Fade out:

<fade out>Text fading out</fade>

Format number

Format a decimal number

<format format=#.## mode=HALF_EVEN>2.5424</format>
Option Description Default
Format The decimal format used to format this number, see Decimal Formatting for more information #.##
Mode Rounding mode to use when formatting, see Rounding Modes for more information HALF_EVEN

Gradient

Gradient

This animation utilises hexadecimal colours and is only available on KiteBoard 3.2 with Minecraft 1.16

<gradient from=#FF0000 to=#0000FF>Text with red to blue gradient</gradient>
<gradient rainbow>Text with a rainbow gradient</gradient>
<gradient colors=#FF000,#00FF00,#0000FF>Text with a red to green to blue gradient.</gradient>
Option Description Default
From Starting colour of the gradient #FF0000
To Ending colour of the gradient #0000FF
Colors A list of colours to be used for advanced gradients (This overrides the to & from parameters)
Rainbow Set the gradient to a rainbow, this enables the HSB option false
Hsb Use HSB colour interpolation (required for rainbow) false

Health bar


Creates a healthbar

<healthbar symbol= fill=&c empty=&7 size=10 max=20>%player_health%</healthbar>
Option Description Default
Symbol Symbol used to represent the health bar
Fill Colour to fill the health bar with &c
Empty Colour to fill the empty health bar with &7
Size Number of symbols used to represent healthbar 10
Max Maximum value of health bar. This should be an entity's max health. For event triggers use: {event.getEntity.getMaxHealth} 20

Marquee

Create marquee/scrolling text

<marquee width=32 space=32>Scrolling text</marquee>
Option Description Default
Width Width of container to fit the scroller within 32
Space Whitespace between scrolling the text again. This is required to be longer than the provided width. 32

Pause

Repeat text for a number of frames.

<pause times=10>This text is repeated for 10 frames</pause>
Option Description Default
Times Amount of frames to repeat this text for 10

Pulse

Create pulsing text

<pulse color=multi pause=1>Pulsating text</pulse>
Option Description Default
Color Colour to pulse, one of: multi, white, black, red, yellow, blue, pink, green, cyan multi
Pause Amount of frames to hold full brightness at 1

Rainbow

Creates a rainbow colour cycle of text.

<rainbow>Rainbow text</rainbow>
Option Description Default
Smooth (3.2/1.16+ only) Enable 1.16 hex colour support true on 1.16 and above
Length (3.2/1.16+ only) Length of gradient 20

Shining text

<shine>Shining Text</shine>
<shine start=&9 middle=&4 end=&9 normal=&7>Shining Text</shine>

Available options:

Option Description Default
Start Starting shine colour &d
Middle Primary shine colour &5
End Ending shine colour &d
Size Length of the shine 5
Normal Normal text colour &f
Speed Step to iterate through the text per frame 1
Pause Amount of frames to pause before running the shine again 10

Typewriter

Create typing text with flashing cursor

<typewriter cursor=_ pause=10 reverse>Typing text</typewriter>
Option Description Default
Cursor Character to use as the flashing symbol _
Pause Amount of frames to pause after typing. 10
Reverse Reverses the animation with un-typing the text True

Wave

<wave>Rainbow wave text</wave>

Customising the colours:

<wave colors=&e,&a,&c>Wave text</wave>
Option Description Default
Colors List of colours for the wave &c,&e,&6,&a,&9,&1,&d
Colors (3.2/1.16+ only) List of colours for the wave (1.16 +, requires hex codes) #FF0000
Hsb (3.2/1.16+ only) HSB Colour interpolation mode false (set to true if one colour is provided)
Length (3.2/1.16+ only) Length of gradient 30
Smooth (3.2/1.16+ only) Enable 1.16 hex colour support true on 1.16 and aboe