pub struct BlockRegistry<V: VoxelType> { /* private fields */ }Expand description
Registry of author-defined block content.
The registry is intentionally a plain Bevy resource. Add
VoxelContentPlugin to initialize it, then populate it from startup
systems or your own setup code.
Implementations§
Source§impl<V: VoxelType> BlockRegistry<V>
impl<V: VoxelType> BlockRegistry<V>
Sourcepub fn register(
&mut self,
definition: BlockDefinition<V>,
) -> Result<(), ContentRegistryError<V>>
pub fn register( &mut self, definition: BlockDefinition<V>, ) -> Result<(), ContentRegistryError<V>>
Registers a new block definition.
Use BlockRegistry::insert_or_replace when your setup intentionally
overwrites an existing definition.
Sourcepub fn insert_or_replace(&mut self, definition: BlockDefinition<V>)
pub fn insert_or_replace(&mut self, definition: BlockDefinition<V>)
Inserts a definition, replacing any previous definition for the same id or voxel value.
Sourcepub fn get(&self, id: impl AsRef<str>) -> Option<&BlockDefinition<V>>
pub fn get(&self, id: impl AsRef<str>) -> Option<&BlockDefinition<V>>
Returns a definition by content id.
Sourcepub fn require(
&self,
id: impl AsRef<str>,
) -> Result<&BlockDefinition<V>, ContentRegistryError<V>>
pub fn require( &self, id: impl AsRef<str>, ) -> Result<&BlockDefinition<V>, ContentRegistryError<V>>
Returns a definition by id or an explicit error.
Sourcepub fn get_by_voxel(&self, voxel: V) -> Option<&BlockDefinition<V>>
pub fn get_by_voxel(&self, voxel: V) -> Option<&BlockDefinition<V>>
Returns a definition by voxel value.
Sourcepub fn contains_id(&self, id: impl AsRef<str>) -> bool
pub fn contains_id(&self, id: impl AsRef<str>) -> bool
Returns true if an id exists.
Sourcepub fn iter(&self) -> impl Iterator<Item = &BlockDefinition<V>>
pub fn iter(&self) -> impl Iterator<Item = &BlockDefinition<V>>
Iterates definitions in unspecified hash-map order.
Sourcepub fn snapshot(&self) -> Vec<BlockContentSnapshot>
pub fn snapshot(&self) -> Vec<BlockContentSnapshot>
Returns deterministic serializable snapshots of all registered blocks.
Trait Implementations§
Source§impl<V: VoxelType> Default for BlockRegistry<V>
impl<V: VoxelType> Default for BlockRegistry<V>
impl<V: VoxelType> Resource for BlockRegistry<V>
Auto Trait Implementations§
impl<V> Forget for BlockRegistry<V>
impl<V> Freeze for BlockRegistry<V>
impl<V> Move for BlockRegistry<V>
impl<V> RefUnwindSafe for BlockRegistry<V>
impl<V> Send for BlockRegistry<V>
impl<V> Sync for BlockRegistry<V>
impl<V> Unpin for BlockRegistry<V>
impl<V> UnsafeUnpin for BlockRegistry<V>
impl<V> UnwindSafe for BlockRegistry<V>
Blanket Implementations§
Source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
Source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
Return the
T ShaderType for self. When used in AsBindGroup
derives, it is safe to assume that all images in self exist.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Settings for T
Source§impl<T, U> ToSample<U> for Twhere
U: FromSample<T>,
impl<T, U> ToSample<U> for Twhere
U: FromSample<T>,
fn to_sample_(self) -> U
Source§impl<T> TypeData for T
impl<T> TypeData for T
Source§fn clone_type_data(&self) -> Box<dyn TypeData>
fn clone_type_data(&self) -> Box<dyn TypeData>
Creates a type-erased clone of this value.