Crate valence_scoreboard

valence_scoreboard

This crate provides functionality for creating and managing scoreboards. In Minecraft, a scoreboard references an Objective, which is a mapping from strings to scores. Typically, the string is a player name, and the score is a number of points, but the string can be any arbitrary string <= 40 chars, and the score can be any integer.

In Valence, scoreboards obey the rules implied by EntityLayers, meaning that every Objective must have an EntityLayerId associated with it. Scoreboards are only transmitted to clients if the EntityLayer is visible to the client.

To create a scoreboard, spawn an ObjectiveBundle. The Objective component represents the identifier that the client uses to reference the scoreboard.

Example:

use valence_scoreboard::*;
use valence_server::protocol::text::IntoText;

fn spawn_scoreboard(mut commands: Commands) {
	commands.spawn(ObjectiveBundle {
		name: Objective::new("foo"),
		display: ObjectiveDisplay("Foo".bold()),
		..Default::default()
	});
}

Structs

Objective

A string that identifies an objective. There is one scoreboard per objective.It’s generally not safe to modify this after it’s been created. Limited to 16 characters.

ObjectiveBundle

ObjectiveDisplay

Optional display name for an objective. If not present, the objective’s name is used.

ObjectiveScores

A mapping of keys to their scores.

OldObjectiveScores

ScoreboardPlugin

Provides all necessary systems to manage scoreboards.

ScoreboardSet