Skip to content

levilamina::scoreboard

Scoreboards.

Everything goes through one multiplexed slot, scoreboard_op, where op decides what happens. This layer wraps each op as a named method and separates a score that cannot be read from a score of 0, which the bare slot reports as the same empty output (contract Β§5.2).

Scoreboard

Rust
1
pub struct Scoreboard(/* private */);

The scoreboard facade. Zero sized.

  • Implements: Clone, Copy

Scoreboard::get

Rust
1
pub fn get() -> Scoreboard
  • Return type: Scoreboard

Scoreboard::add_objective

Rust
1
pub fn add_objective(&self, name: &str, display_name: &str) -> Result<()>

Creates a dummy objective. It fails when one of that name already exists.

  • Parameters:
    • name : &str
    • display_name : &str
  • Return type: Result<()>
  • Slots: scoreboard_op

Scoreboard::remove_objective

Rust
1
pub fn remove_objective(&self, name: &str) -> Result<()>
  • Parameters:
    • name : &str
  • Return type: Result<()>
  • Slots: scoreboard_op

Scoreboard::objectives

Rust
1
pub fn objectives(&self) -> Result<Vec<Objective>>

Scoreboard::score

Rust
1
pub fn score(&self, objective: &str, who: &str) -> Result<Option<i64>>

Reads one score.

A person with no score on that objective gives Ok(None), and only an objective that does not exist is an Err. The bare slot collapses both of those and a score of 0 into the same empty output, so this separates them by whether the output is empty and leaves a nonexistent objective for the op itself to report.

  • Parameters:
    • objective : &str
    • who : &str
  • Return type: Result<Option<i64>>
  • Slots: scoreboard_op

Scoreboard::set_score

Rust
1
pub fn set_score(&self, objective: &str, who: &str, value: i64) -> Result<i64>

Sets it to value and returns the value after the write.

  • Parameters:
    • objective : &str
    • who : &str
    • value : i64
  • Return type: Result<i64>
  • Slots: scoreboard_op

Scoreboard::add_score

Rust
1
pub fn add_score(&self, objective: &str, who: &str, delta: i64) -> Result<i64>
  • Parameters:
    • objective : &str
    • who : &str
    • delta : i64
  • Return type: Result<i64>
  • Slots: scoreboard_op

Scoreboard::reduce_score

Rust
1
pub fn reduce_score(&self, objective: &str, who: &str, delta: i64) -> Result<i64>
  • Parameters:
    • objective : &str
    • who : &str
    • delta : i64
  • Return type: Result<i64>
  • Slots: scoreboard_op

Scoreboard::reset_score

Rust
1
pub fn reset_score(&self, objective: &str, who: &str) -> Result<()>

Erases the score of this person on this objective, which is not setting it to 0.

  • Parameters:
    • objective : &str
    • who : &str
  • Return type: Result<()>
  • Slots: scoreboard_op

Scoreboard::set_display

Rust
1
pub fn set_display(&self, slot: DisplaySlot, objective: &str) -> Result<()>
  • Parameters:
    • slot : DisplaySlot
    • objective : &str
  • Return type: Result<()>
  • Slots: scoreboard_op

Scoreboard::clear_display

Rust
1
pub fn clear_display(&self, slot: DisplaySlot) -> Result<()>
  • Parameters:
    • slot : DisplaySlot
  • Return type: Result<()>
  • Slots: scoreboard_op

DisplaySlot

Rust
1
2
3
4
5
pub enum DisplaySlot {
        Sidebar,
        List,
        BelowName,
}

The display slot of a scoreboard.

  • Implements: Debug, Clone, Copy, PartialEq, Eq

DisplaySlot::as_str

Rust
1
pub fn as_str(self) -> &'static str

The host dispatches on this string.

  • Return type: &'static str

Objective

Rust
1
2
3
4
pub struct Objective {
    pub name: String,
    pub display_name: String,
}

One objective.

  • Implements: Debug, Clone, PartialEq, Eq