Struct BossBarRef 

pub struct BossBarRef { /* private fields */ }

A custom boss bar (vanilla’s CustomBossEvent, the /bossbar ones) of an open server world. It holds the world’s epoch and the bar’s UUID, so a bar that was removed (even if its id was added again) or a handle from an earlier open reads as None and changes nothing. Mob and raid bars are not custom boss events and have no handle.

Implementations

impl BossBarRef

pub fn id(self, host: &dyn Host) -> Option<String>

Side: server. The bar’s id (CustomBossEvent.customId), or None for a stale handle.

pub fn name(self, host: &dyn Host) -> Result<Option<Text>, TextFormError>

Side: server. BossEvent.getName. Refuses text deeper than 512 component nodes before applying any changes.

pub fn color(self, host: &dyn Host) -> Option<BossBarColor>

Side: server. BossEvent.getColor.

pub fn overlay(self, host: &dyn Host) -> Option<BossBarOverlay>

Side: server. BossEvent.getOverlay.

pub fn darken_screen(self, host: &dyn Host) -> Option<bool>

Side: server. BossEvent.shouldDarkenScreen.

pub fn play_boss_music(self, host: &dyn Host) -> Option<bool>

Side: server. BossEvent.shouldPlayBossMusic.

pub fn create_world_fog(self, host: &dyn Host) -> Option<bool>

Side: server. BossEvent.shouldCreateWorldFog.

pub fn value(self, host: &dyn Host) -> Option<i32>

Side: server. CustomBossEvent.value.

pub fn max(self, host: &dyn Host) -> Option<i32>

Side: server. CustomBossEvent.max.

pub fn visible(self, host: &dyn Host) -> Option<bool>

Side: server. ServerBossEvent.isVisible.

pub fn players(self, host: &dyn Host) -> Option<Vec<PlayerRef>>

Side: server. ServerBossEvent.getPlayers: the bar’s players who are online.

pub fn set_name( self, host: &mut dyn ServerHost, name: Text, ) -> Result<bool, TextFormError>

Side: server. ServerBossEvent.setName: viewers are sent the new name. Refuses text deeper than 512 component nodes before applying any changes.

pub fn set_color(self, host: &mut dyn ServerHost, color: BossBarColor) -> bool

Side: server. ServerBossEvent.setColor.

pub fn set_overlay( self, host: &mut dyn ServerHost, overlay: BossBarOverlay, ) -> bool

Side: server. ServerBossEvent.setOverlay.

pub fn set_darken_screen(self, host: &mut dyn ServerHost, darken: bool) -> bool

Side: server. ServerBossEvent.setDarkenScreen.

pub fn set_play_boss_music(self, host: &mut dyn ServerHost, music: bool) -> bool

Side: server. ServerBossEvent.setPlayBossMusic.

pub fn set_create_world_fog(self, host: &mut dyn ServerHost, fog: bool) -> bool

Side: server. ServerBossEvent.setCreateWorldFog.

pub fn set_value(self, host: &mut dyn ServerHost, value: i32) -> bool

Side: server. CustomBossEvent.setValue: stored as given, as vanilla does; only the progress shown is kept between empty and full.

pub fn set_max(self, host: &mut dyn ServerHost, max: i32) -> bool

Side: server. CustomBossEvent.setMax: stored as given, and the value is kept. Only /bossbar set max limits it to 1 or more.

pub fn set_visible(self, host: &mut dyn ServerHost, visible: bool) -> bool

Side: server. ServerBossEvent.setVisible: a hidden bar is taken off its players’ screens and keeps them.

pub fn add_player(self, host: &mut dyn ServerHost, player: PlayerRef) -> bool

Side: server. CustomBossEvent.addPlayer. False for a stale bar or an offline or stale player. The bar is kept for the player across sessions.

pub fn remove_player(self, host: &mut dyn ServerHost, player: PlayerRef) -> bool

Side: server. CustomBossEvent.removePlayer. False for a stale bar or an offline or stale player.

pub fn remove(self, host: &mut dyn ServerHost) -> bool

Side: server. /bossbar remove (CustomBossEvents.remove): the bar’s viewers lose it and its handle goes stale.

Trait Implementations

impl Clone for BossBarRef

fn clone(&self) -> BossBarRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BossBarRef

impl Debug for BossBarRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for BossBarRef

impl Hash for BossBarRef

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BossBarRef

fn eq(&self, other: &BossBarRef) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BossBarRef

impl Wire for BossBarRef

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<BossBarRef, WireError>

Decodes one value, leaving any following bytes for the caller.