Commands/bossbar

Creates, modifies and lists bossbars.

Syntax[]

bossbar add <id> <name>

Create a new bossbar.

bossbar get <id> (max|players|value|visible)

Return the requested setting as a result of the command.

bossbar list

Display a list of existing bossbars.

bossbar remove <id>

Remove an existing bossbar.

bossbar set <id> (color|max|name|players|style|value|visible)

... color (blue|green|pink|purple|red|white|yellow)

Set the text color (if no color was specified as part of a text component) and bar color. Defaults to white upon creation.

... max <max>

Set the bossbar's maximum value. Defaults to 100 upon creation.

... name <name>

Set the bossbar's name.

... players [<targets>]

Change the set of players to whom the bar is visible. Defaults to none upon creation.

... style (notched_6|notched_10|notched_12|notched_20|progress)

Set the bossbar's visual amount of segments: continuous, 6 segments, 10 segments, 12 segments, or 20 segments. Defaults to progress upon creation.

... value <value>

Set the bossbar's current value. Defaults to 0 upon creation.

... visible <visible>

Set the bossbar's visibility. Defaults to true upon creation.

Arguments[]

<id>: resource_location

Specifies a unique bossbar.

Must be a resource location which will be resolved during command execution into unregistered content or client-side content.

<name>: component

Specifies the display name of the bossbar.

Must be a raw JSON text.

<max>: integer

Specifies the bossbar's maximum value.

Must be a 32-bit integer number. And it must be between 1 and 2147483647 (inclusive).

<targets>: entity

Specifies the set of players to whom the bar is visible.

Must be a player name, a target selector or a UUID. And the target selector must be of player type.

<value>: integer

Specifies the bossbar's current value.

Must be a 32-bit integer number. And it must be between 0 and 2147483647 (inclusive).

<visible>: bool

Specifies the bossbar's visibility.

Must be a boolean (either true or false).

Result[]

Command	Trigger	Java Edition
any	the arguments are not specified correctly	Unparseable
/bossbar set ... /bossbar remove ... /bossbar get	the specified boss bar doesn't exist	Failed
/bossbar add ...	a boss bar with specified id have already existed
/bossbar set ...	the boss bar's property have already been the same as the specified value
any	Otherwise	Successful

Output[]

Command	Edition	Situation	Success Count	/execute store success ...	/execute store result ...
any	Java Edition	On fail	0	0	0
/bossbar add ... /bossbar list /bossbar remove ...		On success	1	1	The number of custom bossbars that exist after the command is executed. Bossbars created by the game itself (such as the boss bar of the ender dragon) aren't included.
/bossbar get <id> max /bossbar set <id> max		On success	1	1	The boss bar's maximum value after the command's execution.
/bossbar get <id> value /bossbar set <id> value		On success	1	1	The boss bar's value after execution.
/bossbar get <id> players /bossbar set <id> players		On success	1	1	The number of players to whom the bar is visible after execution.
/bossbar get <id> visible		On success	1	1	1 if the boss bar is visible; otherwise 0.
/bossbar set <id> color /bossbar set <id> name /bossbar set <id> style /bossbar set <id> visible		On success	1	1	0

History[]

Java Edition
1.13		18w05a			Added bossbar.