Class Bossbar

constructor

• new Bossbar(
      boss: Entity,
      title?: string,
      percent?: number,
      color?: BossEventColor,
  ): Bossbar

  Constructs a new bossbar ui element.

  Parameters

  • boss: Entity

    The boss entity the bar is associated with. This entity can be the player itself.
  • Optionaltitle: string

    The title of the bossbar.
  • Optionalpercent: number

    The percent of the bossbar.
  • Optionalcolor: BossEventColor

    The color of the bossbar.

  Returns Bossbar

Readonlyboss

color

Readonlyoccupants

percent

title

hide

• hide(player?: Player): void

  Hides the boss bar from a specific player.

  Parameters

  • Optionalplayer: Player

    The player to hide the bossbar from.

  Returns void

  Note

  If no player is provided, the bossbar will be hidden from all occupants.

setColor

• setColor(color: BossEventColor): void

  Updates the boss bar for all occupants.

  Parameters

  • color: BossEventColor

  Returns void

setPercent

• setPercent(percent: number): void

  Updates the boss bar for all occupants.

  Parameters

  • percent: number

  Returns void

setTitle

• setTitle(title: string): void

  Updates the boss bar for all occupants.

  Parameters

  • title: string

  Returns void

show

• show(player: Player): void

  Shows the bossbar to a specific player.

  Parameters

  • player: Player

    The player to show the boss bar to.

  Returns void