Skip to main content

ChunkPos

Struct ChunkPos 

Source
pub struct ChunkPos(pub IVec2);
Expand description

A chunk position.

Tuple Fields§

§0: IVec2

Implementations§

Source§

impl ChunkPos

Source

const OFFSETS: [(i32, i32); 8]

Source

const SAFETY_MARGIN_CHUNKS: i32

Safety margin in chunks for world generation dependencies. Calculated as (32 + GENERATION_PYRAMID.getStepTo(FULL).accumulatedDependencies().size() + 1) * 2. The accumulated dependencies size for FULL is 9 (radius 8 + 1).

Source

pub const MAX_COORDINATE_VALUE: i32

Maximum valid chunk coordinate value. Calculated as SectionPos.blockToSectionCoord(MAX_HORIZONTAL_COORDINATE) - SAFETY_MARGIN_CHUNKS.

Source

pub fn neighbors(self) -> [ChunkPos; 8]

Returns all 8 neighbors of this chunk position.

Source

pub const fn new(x: i32, y: i32) -> Self

Creates a new ChunkPos with the given x and y coordinates.

Source

pub const fn from_block_pos(pos: BlockPos) -> Self

Creates a ChunkPos from a world block position.

Source

pub fn from_entity_pos(pos: DVec3) -> Self

Creates a ChunkPos containing the given floating-point world position.

Source

pub const fn is_valid(x: i32, z: i32) -> bool

Checks if the given chunk coordinates are within valid bounds. Uses Mth.absMax(x, z) <= MAX_COORDINATE_VALUE.

Trait Implementations§

Source§

impl Clone for ChunkPos

Source§

fn clone(&self) -> ChunkPos

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for ChunkPos

Source§

impl Debug for ChunkPos

Source§

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

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

impl Eq for ChunkPos

Source§

impl From<ChunkPos> for PackedChunkPos

Source§

fn from(pos: ChunkPos) -> Self

Converts to this type from the input type.
Source§

impl From<PackedChunkPos> for ChunkPos

Source§

fn from(pos: PackedChunkPos) -> Self

Converts to this type from the input type.
Source§

impl Hash for ChunkPos

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ChunkPos

Source§

fn eq(&self, other: &ChunkPos) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl ReadFrom for ChunkPos

Source§

fn read(data: &mut Cursor<&[u8]>) -> Result<Self>

Reads data from a cursor.
Source§

impl StructuralPartialEq for ChunkPos

Source§

impl WriteTo for ChunkPos

Source§

fn write(&self, writer: &mut impl Write) -> Result<()>

Writes data to a writer.

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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