Struct valence::ChunkLayer

source ·
pub struct ChunkLayer { /* private fields */ }
Expand description

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

Implementations§

source§

impl ChunkLayer

source

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

Creates a new chunk layer.

source

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

The name of the dimension this chunk layer is using.

source

pub fn height(&self) -> u32

The height of this instance’s dimension.

source

pub fn min_y(&self) -> i32

The min_y of this instance’s dimension.

source

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

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

source

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.

source

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 previous chunk data is returned.

source

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.

source

pub fn clear_chunks(&mut self)

Unload all chunks in this instance.

source

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.

source

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

Get a ChunkEntry for the given position.

source

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.

source

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.

source

pub fn shrink_to_fit(&mut self)

Optimizes the memory usage of the instance.

source

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

source

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

source

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

source

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

source

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

source

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.

source

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§

source§

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.
source§

impl Debug for ChunkLayer

source§

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

Formats the value using the given formatter. Read more
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

impl WritePacket for ChunkLayer

source§

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.
source§

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.
source§

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.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<C> Bundle for C
where C: Component,

§

fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )

§

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: 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.
§

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.
§

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.
§

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.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<C> DynamicBundle for C
where C: Component,

§

fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))

§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> SendMessage for T
where T: WritePacket,

source§

fn send_chat_message<'a>(&mut self, msg: impl IntoText<'a>)

Sends a system message visible in the chat.
source§

fn send_action_bar_message<'a>(&mut self, msg: impl IntoText<'a>)

Displays a message in the player’s action bar (text above the hotbar).
source§

impl<T> SetBrand for T
where T: WritePacket,

source§

fn set_brand(&mut self, brand: &str)

Sets the brand of the server. Read more
source§

impl<T> SetTitle for T
where T: WritePacket,

source§

fn set_title<'a>(&mut self, text: impl IntoText<'a>)

Displays a title to a client. Read more
source§

fn set_subtitle<'a>(&mut self, text: impl IntoText<'a>)

source§

fn set_action_bar<'a>(&mut self, text: impl IntoText<'a>)

source§

fn set_title_times(&mut self, fade_in: i32, stay: i32, fade_out: i32)

fade_in: Ticks to spend fading in.stay: Ticks to keep the title displayed.fade_out: Ticks to spend fading out. Read more
source§

fn clear_title(&mut self)

source§

fn reset_title(&mut self)

§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more