Struct BossBarFlags 

pub struct BossBarFlags(/* private fields */);

The flags of a boss bar (darken sky, dragon bar, create fog).

Implementations

impl BossBarFlags

pub const fn new() -> BossBarFlags

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u8) -> BossBarFlags

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn darken_sky(&self) -> bool

Bits: 0..1

pub const fn with_darken_sky_checked( self, value: bool, ) -> Result<BossBarFlags, ()>

Bits: 0..1

pub const fn with_darken_sky(self, value: bool) -> BossBarFlags

Bits: 0..1

pub const fn set_darken_sky(&mut self, value: bool)

Bits: 0..1

pub const fn set_darken_sky_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 0..1

pub const fn dragon_bar(&self) -> bool

Bits: 1..2

pub const fn with_dragon_bar_checked( self, value: bool, ) -> Result<BossBarFlags, ()>

Bits: 1..2

pub const fn with_dragon_bar(self, value: bool) -> BossBarFlags

Bits: 1..2

pub const fn set_dragon_bar(&mut self, value: bool)

Bits: 1..2

pub const fn set_dragon_bar_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 1..2

pub const fn create_fog(&self) -> bool

Bits: 2..3

pub const fn with_create_fog_checked( self, value: bool, ) -> Result<BossBarFlags, ()>

Bits: 2..3

pub const fn with_create_fog(self, value: bool) -> BossBarFlags

Bits: 2..3

pub const fn set_create_fog(&mut self, value: bool)

Bits: 2..3

pub const fn set_create_fog_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 2..3

Trait Implementations

impl Clone for BossBarFlags

fn clone(&self) -> BossBarFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for BossBarFlags

where BossBarFlags: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<BossBarFlags>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for BossBarFlags

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

Formats the value using the given formatter.

impl<'a> Decode<'a> for BossBarFlags

fn decode(_r: &mut &'a [u8]) -> Result<BossBarFlags, Error>

Reads this object from the provided byte slice.

impl Default for BossBarFlags

fn default() -> BossBarFlags

Returns the “default value” for a type.

impl Encode for BossBarFlags

fn encode(&self, _w: impl Write) -> Result<(), Error>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<(), Error>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl From<BossBarFlags> for u8

fn from(v: BossBarFlags) -> u8

Converts to this type from the input type.

impl From<u8> for BossBarFlags

fn from(v: u8) -> BossBarFlags

Converts to this type from the input type.

impl PartialEq for BossBarFlags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BossBarFlags

impl Eq for BossBarFlags

impl StructuralPartialEq for BossBarFlags