Struct BlockPos 

pub struct BlockPos(pub IVec3);

A block position.

Tuple Fields

0: IVec3

Implementations

impl BlockPos

pub const ZERO: BlockPos

pub const MAX_HORIZONTAL_COORDINATE: i32

Maximum horizontal coordinate value: (1 << 26) / 2 - 1 = 33554431

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

Creates a new BlockPos from coordinates.

pub const fn offset(&self, dx: i32, dy: i32, dz: i32) -> Self

Returns a new BlockPos offset by the given amounts.

pub const fn x(&self) -> i32

Returns the x coordinate.

pub const fn y(&self) -> i32

Returns the y coordinate.

pub const fn z(&self) -> i32

Returns the z coordinate.

pub const fn above(&self) -> Self

Returns the position one block above (Y + 1).

pub const fn above_n(&self, n: i32) -> Self

Returns the position n blocks above (Y + n).

pub const fn below(&self) -> Self

Returns the position one block below (Y - 1).

pub const fn below_n(&self, n: i32) -> Self

Returns the position n blocks below (Y - n).

pub const fn north(&self) -> Self

Returns the position one block to the north (Z - 1).

pub const fn south(&self) -> Self

Returns the position one block to the south (Z + 1).

pub const fn west(&self) -> Self

Returns the position one block to the west (X - 1).

pub const fn east(&self) -> Self

Returns the position one block to the east (X + 1).

pub fn relative(self, direction: Direction) -> Self

Returns the position offset by one block in the given direction.

pub fn breadth_first_traversal<NP, P>( start_pos: Self, max_depth: i32, max_count: i32, neighbor_provider: NP, node_processor: P, ) -> i32

where NP: FnMut(Self, &mut dyn FnMut(Self)), P: FnMut(Self) -> TraversalNodeStatus,

Does a breadth-first traversal of all block pos from start_pos

pub fn relative_n(&self, direction: Direction, n: i32) -> Self

Returns the position offset by n blocks in the given direction.

pub fn spiral_around( center: Self, radius: i32, first_direction: Direction, second_direction: Direction, ) -> SpiralAround

Returns vanilla BlockPos.spiralAround.

Panics

Panics if radius is negative or if both directions are on the same axis.

pub const fn relative_axis(&self, axis: Axis, n: i32) -> Self

Returns the position offset by n blocks along the given axis.

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

Returns a new position with the same X and Z but the given Y.

pub const fn multiply(&self, factor: i32) -> Self

Returns a new position with all coordinates multiplied by the given factor.

pub fn get_center(&self) -> (f64, f64, f64)

Returns the center of this block as a floating-point position.

pub fn get_bottom_center(&self) -> (f64, f64, f64)

Returns the bottom center of this block (center of the bottom face).

pub const fn containing(x: f64, y: f64, z: f64) -> Self

Creates a BlockPos containing the given floating-point coordinates.

pub const fn min(a: BlockPos, b: BlockPos) -> Self

Returns the minimum coordinates of two positions.

pub const fn max(a: BlockPos, b: BlockPos) -> Self

Returns the maximum coordinates of two positions.

pub const fn within_manhattan( self, reach_x: i32, reach_y: i32, reach_z: i32, ) -> BlockPosWithinManhattan

Returns positions in vanilla BlockPos.withinManhattan order.

pub fn find_closest_match( self, horizontal_search_radius: i32, vertical_search_radius: i32, predicate: impl FnMut(BlockPos) -> bool, ) -> Option<BlockPos>

Returns vanilla BlockPos.findClosestMatch.

Trait Implementations

impl Clone for BlockPos

fn clone(&self) -> BlockPos

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockPos

impl Debug for BlockPos

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

Formats the value using the given formatter.

impl Eq for BlockPos

impl From<BlockPos> for PackedBlockPos

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.

impl From<BlockPos> for PackedChunkLocalXZ

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.

impl From<BlockPos> for PackedSectionBlockPos

fn from(pos: BlockPos) -> Self

Converts to this type from the input type.

impl From<DVec3> for BlockPos

fn from(value: DVec3) -> Self

Converts to this type from the input type.

impl From<PackedBlockPos> for BlockPos

fn from(pos: PackedBlockPos) -> Self

Converts to this type from the input type.

impl Hash for BlockPos

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

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

Equality operator ==.

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

Inequality operator !=.

impl ReadFrom for BlockPos

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

Reads data from a cursor.

impl StructuralPartialEq for BlockPos

impl WriteTo for BlockPos

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

Writes data to a writer.