Struct RelBlockPos

pub struct RelBlockPos {
    pub x: i16,
    pub y: i32,
    pub z: i16,
}

An offset from a block position.

This fits in 64 bits, so it’s more efficient than a BlockPos in some cases.

The X and Z are limited to ±32k.

Fields

x: i16

y: i32

Note that the y isn’t relative.

z: i16

Implementations

impl RelBlockPos

pub fn get_origin(origin: BlockPos) -> Self

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

pub fn apply(self, origin: BlockPos) -> BlockPos

pub fn from_origin(origin: BlockPos, new: BlockPos) -> Self

Create a new RelBlockPos from a given origin and new position.

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

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

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

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

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

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

Trait Implementations

impl Add for RelBlockPos

type Output = RelBlockPos

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for RelBlockPos

fn clone(&self) -> RelBlockPos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelBlockPos

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

Formats the value using the given formatter.

impl Hash for RelBlockPos

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

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 Mul<i16> for RelBlockPos

type Output = RelBlockPos

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> Self::Output

Performs the * operation.

impl PartialEq for RelBlockPos

fn eq(&self, other: &RelBlockPos) -> 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 Copy for RelBlockPos

impl Eq for RelBlockPos

impl StructuralPartialEq for RelBlockPos