Struct valence_server::layer::chunk::ChunkLayer

pub struct ChunkLayer { /* private fields */ }

A Component containing the chunks and dimension information of a Minecraft world.

Implementations

impl ChunkLayer

pub fn new( dimension_type_name: impl Into<Ident<String>>, dimensions: &DimensionTypeRegistry, biomes: &BiomeRegistry, server: &Server ) -> Self

Creates a new chunk layer.

pub fn dimension_type_name(&self) -> Ident<&str>

The name of the dimension this chunk layer is using.

pub fn height(&self) -> u32

The height of this instance’s dimension.

pub fn min_y(&self) -> i32

The min_y of this instance’s dimension.

pub fn chunk(&self, pos: impl Into<ChunkPos>) -> Option<&LoadedChunk>

Get a reference to the chunk at the given position, if it is loaded.

pub fn chunk_mut( &mut self, pos: impl Into<ChunkPos> ) -> Option<&mut LoadedChunk>

Get a mutable reference to the chunk at the given position, if it is loaded.

pub fn insert_chunk( &mut self, pos: impl Into<ChunkPos>, chunk: UnloadedChunk ) -> Option<UnloadedChunk>

Insert a chunk into the instance at the given position. The preivous chunk data is returned.

pub fn remove_chunk( &mut self, pos: impl Into<ChunkPos> ) -> Option<UnloadedChunk>

Unload the chunk at the given position, if it is loaded. Returns the chunk if it was loaded.

pub fn clear_chunks(&mut self)

Unload all chunks in this instance.

pub fn retain_chunks<F>(&mut self, f: F)where F: FnMut(ChunkPos, &mut LoadedChunk) -> bool,

Retain only the chunks for which the given predicate returns true.

pub fn chunk_entry(&mut self, pos: impl Into<ChunkPos>) -> ChunkEntry<'_>

Get a ChunkEntry for the given position.

pub fn chunks( &self ) -> impl Iterator<Item = (ChunkPos, &LoadedChunk)> + Clone + '_

Get an iterator over all loaded chunks in the instance. The order of the chunks is undefined.

pub fn chunks_mut( &mut self ) -> impl Iterator<Item = (ChunkPos, &mut LoadedChunk)> + '_

Get an iterator over all loaded chunks in the instance, mutably. The order of the chunks is undefined.

pub fn shrink_to_fit(&mut self)

Optimizes the memory usage of the instance.

pub fn block(&self, pos: impl Into<BlockPos>) -> Option<BlockRef<'_>>

pub fn set_block( &mut self, pos: impl Into<BlockPos>, block: impl IntoBlock ) -> Option<Block>

pub fn block_entity_mut( &mut self, pos: impl Into<BlockPos> ) -> Option<&mut Compound>

pub fn biome(&self, pos: impl Into<BlockPos>) -> Option<BiomeId>

pub fn set_biome( &mut self, pos: impl Into<BlockPos>, biome: BiomeId ) -> Option<BiomeId>

pub fn play_particle( &mut self, particle: &Particle, long_distance: bool, position: impl Into<DVec3>, offset: impl Into<Vec3>, max_speed: f32, count: i32 )

Puts a particle effect at the given position in the world. The particle effect is visible to all players in the instance with the appropriate chunk in view.

pub fn play_sound( &mut self, sound: Sound, category: SoundCategory, position: impl Into<DVec3>, volume: f32, pitch: f32 )

Plays a sound effect at the given position in the world. The sound effect is audible to all players in the instance with the appropriate chunk in view.

Trait Implementations

impl Component for ChunkLayerwhere Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for ChunkLayer

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

Formats the value using the given formatter.

impl Layer for ChunkLayer

type ExceptWriter<'a> = ExceptWriter<'a>

Packet writer returned by except_writer.

type ViewWriter<'a> = ViewWriter<'a>

Packet writer returned by view_writer.

type ViewExceptWriter<'a> = ViewExceptWriter<'a>

Packet writer returned by view_except_writer.

type RadiusWriter<'a> = RadiusWriter<'a>

Packet writer returned by radius_writer.

type RadiusExceptWriter<'a> = RadiusExceptWriter<'a>

Packet writer returned by radius_except_writer.

fn except_writer(&mut self, except: Entity) -> Self::ExceptWriter<'_>

Returns a packet writer which sends packets to all viewers not identified by except.

fn view_writer(&mut self, pos: impl Into<ChunkPos>) -> Self::ViewWriter<'_>

Returns a packet writer which sends packets to viewers in view of the chunk position pos.

fn view_except_writer( &mut self, pos: impl Into<ChunkPos>, except: Entity ) -> Self::ViewExceptWriter<'_>

Returns a packet writer which sends packets to viewers in view of the chunk position pos and not identified by except.

fn radius_writer( &mut self, center: impl Into<BlockPos>, radius: u32 ) -> Self::RadiusWriter<'_>

Returns a packet writer which sends packets to viewers within radius blocks of the block position pos.

fn radius_except_writer( &mut self, center: impl Into<BlockPos>, radius: u32, except: Entity ) -> Self::RadiusExceptWriter<'_>

Returns a packet writer which sends packets to viewers within radius blocks of the block position pos and not identified by except.

impl WritePacket for ChunkLayer

fn write_packet_fallible<P>(&mut self, packet: &P) -> Result<()>where P: Packet + Encode,

Writes a packet to this object. The result of encoding the packet is returned.

fn write_packet_bytes(&mut self, bytes: &[u8])

Copies raw packet data directly into this object. Don’t use this unless you know what you’re doing.

fn write_packet<P>(&mut self, packet: &P)where P: Packet + Encode,

Writes a packet to this object. Encoding errors are typically logged and discarded.