Struct azalea_core::position::BlockPos

source ·
pub struct BlockPos {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}
Expand description

The coordinates of a block in the world. For entities (if the coordinate with decimals), use Vec3 instead.

Fields§

§x: i32§y: i32§z: i32

Implementations§

source§

impl BlockPos

source

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

source

pub fn length_sqr(&self) -> i32

Get the distance of this vector to the origin by doing x^2 + y^2 + z^2.

source

pub fn distance_to_sqr(&self, other: &Self) -> i32

Get the squared distance from this position to another position. Equivalent to (self - other).length_sqr().

source

pub fn horizontal_distance_sqr(&self) -> i32

source

pub fn horizontal_distance_to_sqr(&self, other: &Self) -> i32

source

pub fn down(&self, y: i32) -> Self

Return a new instance of this position with the y coordinate decreased by the given number.

source

pub fn up(&self, y: i32) -> Self

Return a new instance of this position with the y coordinate increased by the given number.

source

pub fn north(&self, z: i32) -> Self

Return a new instance of this position with the z coordinate subtracted by the given number.

source

pub fn east(&self, x: i32) -> Self

Return a new instance of this position with the x coordinate increased by the given number.

source

pub fn south(&self, z: i32) -> Self

Return a new instance of this position with the z coordinate increased by the given number.

source

pub fn west(&self, x: i32) -> Self

Return a new instance of this position with the x coordinate subtracted by the given number.

source

pub fn dot(&self, other: Self) -> i32

source§

impl BlockPos

source

pub fn center(&self) -> Vec3

Get the absolute center of a block position by adding 0.5 to each coordinate.

source

pub fn to_vec3_floored(&self) -> Vec3

Convert the block position into a Vec3 without centering it.

source

pub fn length_manhattan(&self) -> u32

Get the distance of this vector from the origin by doing x + y + z.

Trait Implementations§

source§

impl Add for &BlockPos

§

type Output = BlockPos

The resulting type after applying the + operator.
source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
source§

impl Add for BlockPos

§

type Output = BlockPos

The resulting type after applying the + operator.
source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
source§

impl AddAssign for BlockPos

source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
source§

impl Clone for BlockPos

source§

fn clone(&self) -> BlockPos

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BlockPos

source§

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

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

impl Default for BlockPos

source§

fn default() -> BlockPos

Returns the “default value” for a type. Read more
source§

impl Display for BlockPos

source§

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

Display a block position as x y z.

source§

impl From<&(i32, i32, i32)> for BlockPos

source§

fn from(pos: &(i32, i32, i32)) -> Self

Converts to this type from the input type.
source§

impl From<&BlockPos> for ChunkBlockPos

source§

fn from(pos: &BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<&BlockPos> for ChunkPos

source§

fn from(pos: &BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<&BlockPos> for ChunkSectionPos

source§

fn from(pos: &BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<&Vec3> for BlockPos

source§

fn from(pos: &Vec3) -> Self

Converts to this type from the input type.
source§

impl From<(i32, i32, i32)> for BlockPos

source§

fn from(pos: (i32, i32, i32)) -> Self

Converts to this type from the input type.
source§

impl From<BlockPos> for (i32, i32, i32)

source§

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<BlockPos> for ChunkBlockPos

source§

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<BlockPos> for ChunkPos

source§

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<BlockPos> for ChunkSectionBlockPos

source§

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<BlockPos> for ChunkSectionPos

source§

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.
source§

impl From<Vec3> for BlockPos

source§

fn from(pos: Vec3) -> Self

Converts to this type from the input type.
source§

impl Hash for BlockPos

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 McBufReadable for BlockPos

source§

fn read_from(buf: &mut Cursor<&[u8]>) -> Result<Self, BufReadError>

source§

impl McBufWritable for BlockPos

source§

fn write_into(&self, buf: &mut impl Write) -> Result<(), Error>

source§

impl Mul<i32> for BlockPos

§

type Output = BlockPos

The resulting type after applying the * operator.
source§

fn mul(self, multiplier: i32) -> Self::Output

Performs the * operation. Read more
source§

impl PartialEq for BlockPos

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Rem<i32> for BlockPos

§

type Output = BlockPos

The resulting type after applying the % operator.
source§

fn rem(self, rhs: i32) -> Self::Output

Performs the % operation. Read more
source§

impl Sub for &BlockPos

source§

fn sub(self, other: Self) -> Self::Output

Find the difference between two positions.

§

type Output = BlockPos

The resulting type after applying the - operator.
source§

impl Sub for BlockPos

§

type Output = BlockPos

The resulting type after applying the - operator.
source§

fn sub(self, other: Self) -> Self::Output

Performs the - operation. Read more
source§

impl Copy for BlockPos

source§

impl Eq for BlockPos

source§

impl StructuralPartialEq for BlockPos

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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,

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.
source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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