Struct valence::ChunkLayer

pub struct ChunkLayer { /* private fields */ }

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

Implementations

impl ChunkLayer

pub fn new<N>( dimension_type_name: N, dimensions: &DimensionTypeRegistry, biomes: &BiomeRegistry, server: &Server, ) -> ChunkLayer

where N: Into<Ident<String>>,

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<P>(&self, pos: P) -> Option<&LoadedChunk>

where P: Into<ChunkPos>,

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

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

where P: Into<ChunkPos>,

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

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

where P: Into<ChunkPos>,

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

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

where P: Into<ChunkPos>,

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<P>(&mut self, pos: P) -> ChunkEntry<'_>

where P: Into<ChunkPos>,

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<P>(&self, pos: P) -> Option<BlockRef<'_>>

where P: Into<BlockPos>,

pub fn set_block<P, B>(&mut self, pos: P, block: B) -> Option<Block>

where P: Into<BlockPos>, B: IntoBlock,

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

where P: Into<BlockPos>,

pub fn biome<P>(&self, pos: P) -> Option<BiomeId>

where P: Into<BiomePos>,

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

where P: Into<BiomePos>,

pub fn play_particle<P, O>( &mut self, particle: &Particle, long_distance: bool, position: P, offset: O, max_speed: f32, count: i32, )

where P: Into<DVec3>, O: Into<Vec3>,

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<P>( &mut self, sound: Sound, category: SoundCategory, position: P, volume: f32, pitch: f32, )

where P: Into<DVec3>,

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 ChunkLayer

where ChunkLayer: 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<(), Error>

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, ) -> <ChunkLayer as Layer>::ExceptWriter<'_>

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

fn view_writer( &mut self, pos: impl Into<ChunkPos>, ) -> <ChunkLayer as Layer>::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, ) -> <ChunkLayer as Layer>::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, ) -> <ChunkLayer as Layer>::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, ) -> <ChunkLayer as Layer>::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<(), Error>

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.