Struct ChunkManager 

pub struct ChunkManager { /* private fields */ }

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

impl ChunkManager

pub fn new(chunk_size: Vec3) -> Self

Creates a new chunk manager with the specified chunk size.

pub fn get_size(&self) -> Vec3

Returns the size of chunks in world units.

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.

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.

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)
}

Examples found in repository

examples/chunk_saving_auto.rs (line 99)

fn show_info(
    chunks: Query<&ChunkPos, With<Chunk>>,
    movers: Query<&Transform, With<Mover>>,
    chunk_manager: Res<ChunkManager>,
) {
    // Log occasionally
    static mut FRAME: u32 = 0;
    unsafe {
        FRAME += 1;
        if FRAME % 120 != 0 {
            return;
        }
    }

    let count = chunks.iter().count();
    if let Ok(transform) = movers.single() {
        let loader_chunk = chunk_manager.get_chunk_pos(&transform.translation);
        info!(
            "Loader at chunk {:?}, {} chunks loaded",
            loader_chunk, count
        );
    }
}

examples/chunk_unloading.rs (line 243)

fn update_ui(
    mut text_query: Query<&mut Text, With<StatsText>>,
    chunks: Query<&ChunkPos, With<Chunk>>,
    pinned: Query<(), With<ChunkPinned>>,
    player: Query<&Transform, With<Player>>,
    strategy: Res<State<UnloadStrategy>>,
    chunk_manager: Res<ChunkManager>,
) {
    let Ok(mut text) = text_query.single_mut() else {
        return;
    };
    let Ok(player_transform) = player.single() else {
        return;
    };

    let chunk_count = chunks.iter().count();
    let pinned_count = pinned.iter().count();
    let player_chunk = chunk_manager.get_chunk_pos(&player_transform.translation);

    **text = format!(
        "Chunks: {} (pinned: {})\n\
         Player chunk: {}\n\
         \n\
         Strategy: {}\n\
         \n\
         [Space] Cycle strategy\n\
         [WASD/QE] Move\n\
         [Right-click + drag] Look",
        chunk_count,
        pinned_count,
        player_chunk,
        strategy.get().label(),
    );
}

pub fn get_chunk(&self, chunk_pos: &IVec3) -> Option<Entity>

Gets the chunk entity at the specified chunk position if it exists.

pub fn get_chunk_form_pos(&self, pos: &Vec3) -> Option<Entity>

Gets the chunk entity at the specified world position if it exists.

pub fn is_loaded(&self, chunk_pos: &IVec3) -> bool

Checks if a chunk is loaded at the specified chunk position.

Trait Implementations

impl Default for ChunkManager

fn default() -> ChunkManager

Returns the “default value” for a type.

impl Resource for ChunkManager

where Self: Send + Sync + 'static,