Struct PartialChunkStorage

pub struct PartialChunkStorage { /* private fields */ }

An efficient storage of chunks for a client that has a limited render distance. This has support for using a shared ChunkStorage.

Implementations

impl PartialChunkStorage

pub fn new(chunk_radius: u32) -> Self

pub fn update_view_center(&mut self, view_center: ChunkPos)

Update the chunk to center the view on. This should be called when the client receives a SetChunkCacheCenter packet.

pub fn view_center(&self) -> ChunkPos

Get the center of the view. This is usually the chunk that the player is in.

pub fn view_range(&self) -> u32

pub fn index_from_chunk_pos(&self, chunk_pos: &ChunkPos) -> usize

pub fn chunk_pos_from_index(&self, index: usize) -> ChunkPos

pub fn in_range(&self, chunk_pos: &ChunkPos) -> bool

pub fn set_block_state( &self, pos: &BlockPos, state: BlockState, chunk_storage: &ChunkStorage, ) -> Option<BlockState>

pub fn replace_with_packet_data( &mut self, pos: &ChunkPos, data: &mut Cursor<&[u8]>, heightmaps: &NbtCompound, chunk_storage: &mut ChunkStorage, ) -> Result<(), BufReadError>

pub fn limited_get(&self, pos: &ChunkPos) -> Option<&Arc<RwLock<Chunk>>>

Get a Chunk within render distance, or None if it’s not loaded. Use ChunkStorage::get to get a chunk from the shared storage.

pub fn limited_get_mut( &mut self, pos: &ChunkPos, ) -> Option<&mut Option<Arc<RwLock<Chunk>>>>

Get a mutable reference to a Chunk within render distance, or None if it’s not loaded. Use ChunkStorage::get to get a chunk from the shared storage.

pub fn set( &mut self, pos: &ChunkPos, chunk: Option<Chunk>, chunk_storage: &mut ChunkStorage, )

Set a chunk in the shared storage and reference it from the limited storage. Use Self::limited_set if you already have an Arc<RwLock<Chunk>>.

Panics

If the chunk is not in the render distance.

pub fn limited_set(&mut self, pos: &ChunkPos, chunk: Option<Arc<RwLock<Chunk>>>)

Set a chunk in our limited storage, useful if your chunk is already referenced somewhere else and you want to make it also be referenced by this storage.

Use Self::set if you don’t already have an Arc<RwLock<Chunk>>.

Panics

If the chunk is not in the render distance.

pub fn chunks(&self) -> impl Iterator<Item = &Option<Arc<RwLock<Chunk>>>>

Get an iterator over all the chunks in the storage.

Trait Implementations

impl Debug for PartialChunkStorage

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

Formats the value using the given formatter.

impl Default for PartialChunkStorage

fn default() -> Self

Returns the “default value” for a type.