Boss Bar Effect

Source Code

effect: bossbar

Description:

Shows a message on the boss bar.

Configuration:

Since 4.0 Beta 13 these options (except for namespace-key before 4.0-Beta-13-patch-1) support dynamic values through numeric or string expressions.

Option	Description	Type	Default
namespace-key	Defines boss bar namespace to allow for multiple bars to be present at a time.	String
title	Title of the boss bar.	Rich Text
remove	If true, instead remove the boss bar associated with the namespace key.	Boolean	false
visible	Defines if the boss bar is visible.	Boolean	true
broadcast	Defines if this boss bar should be broadcast to all players.	Boolean	false
use-viewer-as-target	Since 4.0 Beta 13. Determines the recipient of variable replacement.	Boolean	false
use-viewer-as-default	Since 4.0 Beta 13. Determines the recipient of variable replacement.	Boolean	true
duration	Duration of the boss bar in server ticks. 0 is indefinite.	Integer	60
progress	Progress of the boss bar.	Double	1
max-value	Max value for the bossbar.	Double	100
max-variable	Max value fetched from a variable.	Variable name
color		Bar Color	"red"
style		Bar Style	"solid"
variable	Name of the variable to display on the boss bar.	Variable name

Example:

bossbar:
    spell-class: ".instant.DummySpell"
    effects:
        eff1:
            position: caster
            effect: bossbar
            title: "&bTest Boss Bar Message!"
            color: RED
            style: SOLID
            progress: 0.75
            duration: 100

variables:
    boss_bar:
        type: player
        default: 1
        min: 1
        max: 100

bossbarvariable:
    spell-class: ".instant.DummySpell"
    str-cast-self: "%var:boss_bar%"
    effects:
        eff1:
            position: caster
            effect: bossbar
            title: "&eBoss Bar Variable:"
            color: GREEN
            style: SEGMENTED_20
            variable: boss_bar
            max-value: 100
            duration: 100