Struct valence::prelude::BlockPos

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

Represents an absolute block position in world space.

Fields

x: i32

y: i32

z: i32

Implementations

impl BlockPos

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

Constructs a new block position.

pub const fn get_in_direction(self, dir: Direction) -> BlockPos

Get a new BlockPos that is adjacent to this position in dir direction.

use valence_protocol::{BlockPos, Direction};

let pos = BlockPos::new(0, 0, 0);
let adj = pos.get_in_direction(Direction::South);
assert_eq!(adj, BlockPos::new(0, 0, 1));

pub const fn offset(self, x: i32, y: i32, z: i32) -> BlockPos

pub const fn packed(self) -> Result<PackedBlockPos, Error>

Trait Implementations

impl Add<BlockPos> for IVec3

type Output = BlockPos

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<IVec3> for BlockPos

type Output = BlockPos

The resulting type after applying the + operator.

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

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 Decode<'_> for BlockPos

fn decode(r: &mut &[u8]) -> Result<BlockPos, Error>

Reads this object from the provided byte slice.

impl Default for BlockPos

fn default() -> BlockPos

Returns the “default value” for a type.

impl Display for BlockPos

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

Formats the value using the given formatter.

impl Encode for BlockPos

fn encode(&self, w: impl Write) -> Result<(), Error>

Writes this object to the provided writer.

fn encode_slice(slice: &[Self], w: impl Write) -> Result<(), Error>

where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

impl From<[i32; 3]> for BlockPos

fn from(_: [i32; 3]) -> BlockPos

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<BlockPos> for BiomePos

fn from(pos: BlockPos) -> BiomePos

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

fn from(pos: BlockPos) -> ChunkSectionPos

Converts to this type from the input type.

impl From<BlockPos> for Error

fn from(value: BlockPos) -> Error

Converts to this type from the input type.

impl From<DVec3> for BlockPos

fn from(pos: DVec3) -> BlockPos

Converts to this type from the input type.

impl From<PackedBlockPos> for BlockPos

fn from(p: PackedBlockPos) -> BlockPos

Converts to this type from the input 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 Ord for BlockPos

fn cmp(&self, other: &BlockPos) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &BlockPos) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<BlockPos> for IVec3

type Output = BlockPos

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<IVec3> for BlockPos

type Output = BlockPos

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<BlockPos> for PackedBlockPos

type Error = Error

The type returned in the event of a conversion error.

fn try_from( pos: BlockPos, ) -> Result<PackedBlockPos, <PackedBlockPos as TryFrom<BlockPos>>::Error>

Performs the conversion.

impl Copy for BlockPos

impl Eq for BlockPos

impl StructuralPartialEq for BlockPos