Name | Sidebar |
Syntax | sidebar (add/remove/{set}/set_line) (title:<title>) (scores:<#>|...) (values:<line>|...) (start:<#>/{num_of_lines}) (increment:<#>/{-1}) (players:<player>|...) (per_player) |
Short Description | Controls clientside-only sidebars. |
Full Description | This command was created as a simpler replacement for using the Scoreboard command to display per-player sidebars.
By using packets and dummies, it enables you to have non-flickering, fully functional sidebars, without wasting processing speed and memory on creating new Scoreboards for every single player. Using this command, you can add, remove, or set lines on the scoreboard. To set the title of the sidebar, use the 'title:' parameter in any case where the action is 'set'. By default, the score numbers descend from the total line count to 1. To customize the automatic score values, use the 'start:' and 'increment:' arguments in any case where the action is 'set'. 'Start' is the score where the first line will be shown with. The default 'start' value is determined by how many items are specified in 'values:'. 'Increment' is the difference between each score and the default is -1. To instead set entirely custom numbers, use the 'scores:' input with a list of numbers, where each number is the score to use with the value at the same place in the 'values:' list. You can remove by line value text, or by score number. The per_player argument is also available, and helps to reduce the number of loops required for updating multiple players' sidebars. When it is specified, all tags in the command will fill based on each individual player in the players list. So, for example, you could have <player.name> on a line and it will show each player specified their name on that line. |
Related Tags | <PlayerTag.sidebar_lines> Returns the current lines set on the player's Sidebar via sidebar.
<PlayerTag.sidebar_title> Returns the current title set on the player's Sidebar via sidebar.
<PlayerTag.sidebar_scores> Returns the current scores set on the player's Sidebar via sidebar, (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/SidebarCommand.java#L37 |