Struct Scoreboard 

pub struct Scoreboard {
    state: SyncRwLock<PersistentScoreboard>,
    revision: AtomicU64,
    saved_revision: AtomicU64,
}

Command-facing scoreboard for one Steel domain.

Fields

state: SyncRwLock<PersistentScoreboard>

revision: AtomicU64

saved_revision: AtomicU64

Implementations

impl Scoreboard

pub fn new() -> Self

Creates an empty, clean scoreboard.

fn from_persistent(state: PersistentScoreboard) -> Result<Self, ScoreboardError>

pub fn add_objective( &self, name: impl Into<String>, ) -> Result<ScoreboardObjective, ScoreboardError>

Adds a writable objective.

Errors

Returns an error if the objective name is empty or already exists.

pub fn add_objective_with_read_only( &self, name: impl Into<String>, read_only: bool, ) -> Result<ScoreboardObjective, ScoreboardError>

Adds an objective with explicit command mutability.

Errors

Returns an error if the objective name is empty or already exists.

pub fn objective(&self, name: &str) -> Option<ScoreboardObjective>

Returns an objective by name.

pub fn objective_names(&self) -> Vec<String>

Returns objective names in stable order.

pub fn add_team( &self, name: impl Into<String>, ) -> Result<ScoreboardTeam, ScoreboardError>

Adds a team.

Errors

Returns an error if the team name is empty or already exists.

pub fn team(&self, name: &str) -> Option<ScoreboardTeam>

Returns a team by name.

pub fn team_names(&self) -> Vec<String>

Returns team names in stable order.

pub fn holder_team_name(&self, holder: &ScoreHolder) -> Option<String>

Returns the current team name for a score holder.

pub fn add_holder_to_team( &self, holder: &ScoreHolder, team: &ScoreboardTeam, ) -> Result<(), ScoreboardError>

Adds a holder to a team, replacing any prior membership.

Errors

Returns an error for an empty holder or a team that no longer exists.

pub fn tracked_holders(&self) -> Vec<ScoreHolder>

Returns tracked score holders in stable order.

pub fn score_entry( &self, holder: &ScoreHolder, objective: &ScoreboardObjective, ) -> Option<ScoreboardScore>

Returns the complete score entry for a holder and objective.

pub fn score( &self, holder: &ScoreHolder, objective: &ScoreboardObjective, ) -> Option<i32>

Returns the integer score for a holder and objective.

pub fn set_score( &self, holder: &ScoreHolder, objective: &ScoreboardObjective, value: i32, ) -> Result<(), ScoreboardError>

Sets a holder’s score, preserving its lock state when already present.

Errors

Returns an error for an empty holder, a missing objective, or a read-only objective.

pub fn set_score_locked( &self, holder: &ScoreHolder, objective: &ScoreboardObjective, locked: bool, ) -> Result<(), ScoreboardError>

Changes a score’s trigger lock state.

Errors

Returns an error for an empty holder or a missing objective.

pub fn holder_objectives(&self, holder: &ScoreHolder) -> BTreeSet<String>

Returns objective names that have a score for the holder.

fn mark_dirty(&self)

fn pending_save(&self) -> Option<ScoreboardSaveSnapshot>

fn mark_saved(&self, revision: u64)

Trait Implementations

impl Default for Scoreboard

fn default() -> Self

Returns the “default value” for a type.