TypeEmber

Sidebar

A scoreboard sidebar from ui.sidebar, shown to nobody until show. Up to 15 lines of MiniMessage, top to bottom.

Methods

sidebar:setTitle(text: string)#

Changes the title.

sidebar:setLines(lines: { string })#

Replaces every line (at most 15), as a list or as separate arguments. Stops any showScores.

sidebar:setLine(line: number, text: string?)#

Sets one line (1..15); nil blanks it. Trailing blank lines are dropped. Stops any showScores.

sidebar:show(player: Player)#

Shows the sidebar to a player, replacing any other sidebar of this script they saw.

sidebar:hide(player: Player)#

Hides it from a player.

sidebar:showScores(objective: string?, max: number?, format: string?)#

Keeps the lines in step with an objective (default "score"), highest first, max lines (1..15, default 15). format fills {name}, {value} and {rank}; default "{name}: {value}".

sidebar:destroy()#

Hides it from everyone and frees it. Using the handle afterwards raises.