Templates - Kirastur/BossbarCountdown GitHub Wiki

A template is a set of parameters and actions which defines a BossbarContdown. The Template can then assigned to players to start the countdown.

Color

Color: <BarColor>

For a Bossbar, mincecraft does not allow all colors, only a limited subset is avail. A list of potential colors can be found in the Spigot Javadocs. Default is GREEN.

Style

Style: <BarStyle>

Define the style of the bossbar (e.g. solid, segmented etc.). A list of potential syles can be found in the Spigot Javadocs. Default is SOLID.

Flags

Flags: <Space separated list of BarFlags>

Defines additional effects. A list of potential Flags can be found in theSpigot Javadocs. Default is no flags.

Annotation: Some flags seems only to work in special worlds.

Title

Title: <String>

Set the title of the Bossbar. The title can be changed at runtime using the /bbcd settitle command or the API. Default is an empty string.

Left

Left: <Numeric value of type double>

Define the left border of the bossbar. Default is "0.0".

Right

Right: <Numeric value of type double>

Define the right border of the bossbar. The Left and Right parametrs define the scale of the Bossbar. Default is "1.0".

Start

Start: <Numeric value of type double>

Define the initial value that is assignd to the progress when the template is assigned to a player. If you design an normal countdown, this should be the same as Right. Default is "1.0"

Speed

Speed: <Numeric value of type double>

Define the initial speed of the Countdown. Every tick (which is 1/20 of a second) the progress is incremented by this value. To decrement the progress simply use a negative value. Default is "-0.01". If you use all default values (Left=0, Right=1) the Bossbar will run for 100 ticks, which are 5 seconds.

End

End: <Numeric value of type double>

Define the goal the progress must reach to execute the final actions. Default is "0.0".

Autostart

Autostart: true|false

If you use /bbcd show to create an new BossbarCountdown, the countdown does only start if Autostart is true. If Autostart is false, the Bossbar is only shown, but with no active countdown. The Autostart parameter has no effect if the Bossbar does already exists or if the /bbcd start command is used to create the Bossbar (in the last case the countdown is always started, regardless of the Autostart settings). Default is "true".

Show

Show: true|false

If you use /bbcd start to create an new BossbarCountdown, the Bossbar is only shown if Show is true. If Show is false, the Bossbar starts only its countdown, but stays hidden for the player. The Show parameter has no effect if the Bossbar does already exists or if the /bbcd show command is used to create the Bossbar (in the last case the countdown is always shown, regardless of the Show settings). Default is "true".

Command

Command: <String>

Here you define the command which should be executed when the progress reaches the goal (the end-value), without the leading "/". The command is executed as "console sender". Default is "", which means that no command is executed. The BBCDGoalReachedEvent is always sent.