Struct BlockPos

pub struct BlockPos {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

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

impl BlockPos

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

pub fn length_sqr(&self) -> i32

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

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

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

pub fn horizontal_distance_sqr(&self) -> i32

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl BlockPos

pub fn center(&self) -> Vec3

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

pub fn to_vec3_floored(&self) -> Vec3

Convert the block position into a Vec3 without centering it.

pub fn length_manhattan(&self) -> u32

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

Trait Implementations

impl Add for &BlockPos

type Output = BlockPos

The resulting type after applying the + operator.

fn add(self, rhs: &BlockPos) -> <&BlockPos as Add>::Output

Performs the + operation.

impl Add for BlockPos

type Output = BlockPos

The resulting type after applying the + operator.

fn add(self, rhs: BlockPos) -> <BlockPos as Add>::Output

Performs the + operation.

impl AddAssign for BlockPos

fn add_assign(&mut self, rhs: BlockPos)

Performs the += operation.

impl Clone for BlockPos

fn clone(&self) -> BlockPos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockPos

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

Formats the value using the given formatter.

impl Default for BlockPos

fn default() -> BlockPos

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockPos

fn deserialize<__D>( __deserializer: __D, ) -> Result<BlockPos, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockPos

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

Display a block position as x y z.

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

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

Converts to this type from the input type.

impl From<&BlockPos> for ChunkPos

fn from(pos: &BlockPos) -> ChunkPos

Converts to this type from the input type.

impl From<&LastSentPosition> for BlockPos

fn from(value: &LastSentPosition) -> BlockPos

Converts to this type from the input type.

impl From<&Position> for BlockPos

fn from(value: &Position) -> BlockPos

Converts to this type from the input type.

impl From<&Vec3> for BlockPos

fn from(pos: &Vec3) -> BlockPos

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<BlockPos> for ChunkPos

fn from(pos: BlockPos) -> ChunkPos

Converts to this type from the input type.

impl From<LastSentPosition> for BlockPos

fn from(value: LastSentPosition) -> BlockPos

Converts to this type from the input type.

impl From<Position> for BlockPos

fn from(value: Position) -> BlockPos

Converts to this type from the input type.

impl From<Vec3> for BlockPos

fn from(pos: Vec3) -> BlockPos

Converts to this type from the input type.

impl FromStr for BlockPos

Parses a string in the format “X Y Z” into a BlockPos.

The input string should contain three integer values separated by spaces, representing the x, y, and z components of the vector respectively. This can be used to parse user input or from BlockPos::to_string.

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<BlockPos, <BlockPos as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for BlockPos

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl McBufReadable for BlockPos

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

impl McBufWritable for BlockPos

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

impl Mul<i32> for BlockPos

type Output = BlockPos

The resulting type after applying the * operator.

fn mul(self, multiplier: i32) -> <BlockPos as Mul<i32>>::Output

Performs the * operation.

impl PartialEq for BlockPos

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Rem<i32> for BlockPos

type Output = BlockPos

The resulting type after applying the % operator.

fn rem(self, rhs: i32) -> <BlockPos as Rem<i32>>::Output

Performs the % operation.

impl Serialize for BlockPos

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for &BlockPos

fn sub(self, other: &BlockPos) -> <&BlockPos as Sub>::Output

Find the difference between two positions.

type Output = BlockPos

The resulting type after applying the - operator.

impl Sub for BlockPos

type Output = BlockPos

The resulting type after applying the - operator.

fn sub(self, other: BlockPos) -> <BlockPos as Sub>::Output

Performs the - operation.

impl Copy for BlockPos

impl Eq for BlockPos

impl StructuralPartialEq for BlockPos