pub struct ChunkManager { /* private fields */ }Expand description
Resource for managing all chunks in the world.
Provides methods to query chunks by position and convert between world positions and chunk positions.
§Example
use bevy::prelude::*;
use chunky_bevy::prelude::*;
fn check_chunk(
chunk_manager: Res<ChunkManager>,
player_pos: Vec3,
) {
// Get the chunk position the player is in
let chunk_pos = chunk_manager.get_chunk_pos(&player_pos);
// Check if that chunk is loaded
if chunk_manager.is_loaded(&chunk_pos) {
println!("Player is in a loaded chunk!");
}
}Implementations§
Source§impl ChunkManager
impl ChunkManager
Sourcepub fn new(chunk_size: Vec3) -> ChunkManager
pub fn new(chunk_size: Vec3) -> ChunkManager
Creates a new chunk manager with the specified chunk size.
Sourcepub fn insert(&mut self, pos: IVec3, id: Entity) -> Option<Entity>
pub fn insert(&mut self, pos: IVec3, id: Entity) -> Option<Entity>
Inserts a new chunk into the manager.
Returns the previous chunk entity if one already existed at this position.
Note: Called automatically when a Chunk component is added.
Sourcepub fn remove(&mut self, pos: &IVec3) -> Option<Entity>
pub fn remove(&mut self, pos: &IVec3) -> Option<Entity>
Removes a chunk from the manager.
Returns the chunk’s entity if it existed.
Note: Called automatically when a Chunk component is removed.
Sourcepub fn get_chunk_pos(&self, pos: &Vec3) -> IVec3
pub fn get_chunk_pos(&self, pos: &Vec3) -> IVec3
Converts world coordinates into chunk position.
§Example
use bevy::prelude::*;
use chunky_bevy::prelude::*;
fn example(chunk_manager: Res<ChunkManager>) {
let world_pos = Vec3::new(15.0, 5.0, 23.0);
let chunk_pos = chunk_manager.get_chunk_pos(&world_pos);
// With default 10x10x10 chunks, this returns IVec3(1, 0, 2)
}Sourcepub fn get_chunk(&self, chunk_pos: &IVec3) -> Option<Entity>
pub fn get_chunk(&self, chunk_pos: &IVec3) -> Option<Entity>
Gets the chunk entity at the specified chunk position if it exists.
Sourcepub fn get_chunk_form_pos(&self, pos: &Vec3) -> Option<Entity>
pub fn get_chunk_form_pos(&self, pos: &Vec3) -> Option<Entity>
Gets the chunk entity at the specified world position if it exists.
Trait Implementations§
Source§impl Default for ChunkManager
impl Default for ChunkManager
Source§fn default() -> ChunkManager
fn default() -> ChunkManager
Returns the “default value” for a type. Read more
impl Resource for ChunkManager
Auto Trait Implementations§
impl Freeze for ChunkManager
impl RefUnwindSafe for ChunkManager
impl Send for ChunkManager
impl Sync for ChunkManager
impl Unpin for ChunkManager
impl UnwindSafe for ChunkManager
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
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> 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>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<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>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> 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)
Convert
&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)
Convert
&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
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
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.