Copy page

• Copy page
• View source

📰 Sidebar

#bs.sidebar:help

Create visually appealing and dynamic sidebars using the scoreboard system.

---

🔧 Functions

You can find below all functions available in this module.

---

Create

#bs.sidebar:create

Create and register a new sidebar.

Inputs:

Function macro:

• Arguments

  • objective: An objective used for the sidebar.

  • display_name: Displayed objective name. Must be a valid SNBT text component.

  • contents: Lines displayed on the sidebar.

    • : Must either be a valid SNBT text component or an array with two SNBT text components for the left and right sides.

Example: Create and display a new sidebar with left-aligned text:

# Create a new sidebar
function #bs.sidebar:create { \
    objective: "my_guessing_game", \
    display_name: { text: "Guess my name" }, \
    contents: [ \
        { text: " Clues:", color: "gold", bold: true }, \
        { text: "  • I gave my name to a famous test" }, \
        { text: "  • I am a pioneer of computer science and AI" }, \
        [{ text: " My name is: " }, { score: { objective: "enigma", name: "VHVyaW5n" }}], \
    ], \
}

# Display the sidebar
scoreboard objectives setdisplay sidebar my_guessing_game

Example: Create and display a new sidebar with right-aligned text:

# Create a new sidebar
function #bs.sidebar:create { \
    objective: "my_guessing_game_2", \
    display_name: { text: "Guess my name V2" }, \
    contents: [ \
        ["", { text: " Clues:", color: "gold", bold: true }], \
        ["", { text: "  • I gave my name to a famous test" }], \
        ["", { text: "  • I am a pioneer of computer science and AI" }], \
        ["", [{ text: " My name is: " }, { score: { objective: "enigma", name: "VHVyaW5n" }}]], \
    ], \
}

# Display the sidebar
scoreboard objectives setdisplay sidebar my_guessing_game_2

Credits: Aksiome

---

Refresh

#bs.sidebar:refresh

Update dynamic parts of the sidebar.

Inputs:

Function macro:

• Arguments

  • objective: The objective for the sidebar to refresh.

Example: Refresh a sidebar:

function #bs.sidebar:refresh {objective:"my_guessing_game"}

Credits: Aksiome

---

💬 Did it help you?

Feel free to leave your questions and feedback below!