Package net.minecraft.core

Class BlockPos

java.lang.Object

net.minecraft.core.Vec3i

net.minecraft.core.BlockPos

All Implemented Interfaces:

Comparable<Vec3i>

Direct Known Subclasses:

BlockPos.MutableBlockPos

@Immutable
public class BlockPos
extends Vec3i

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlockPos.MutableBlockPos
static enum	BlockPos.TraversalNodeStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<BlockPos>	CODEC
private static final org.slf4j.Logger	LOGGER
static final int	MAX_HORIZONTAL_COORDINATE
static final int	PACKED_HORIZONTAL_LENGTH
private static final long	PACKED_X_MASK
static final int	PACKED_Y_LENGTH
private static final long	PACKED_Y_MASK
private static final long	PACKED_Z_MASK
static final StreamCodec<io.netty.buffer.ByteBuf,BlockPos>	STREAM_CODEC
private static final int	X_OFFSET
private static final int	Y_OFFSET
private static final int	Z_OFFSET
static final BlockPos	ZERO	An immutable BlockPos with zero as all coordinates.

Constructor Summary

Constructors

Constructor	Description
BlockPos(int x, int y, int z)
BlockPos(Vec3i vector)

Method Summary

Modifier and Type	Method	Description
BlockPos	above()
BlockPos	above(int p_121972_)	Offset this vector upwards by the given distance.
long	asLong()
static long	asLong(int x, int y, int z)
BlockPos	atY(int y)
BlockPos	below()
BlockPos	below(int p_122000_)	Offset this vector downwards by the given distance.
static Iterable<BlockPos>	betweenClosed(int x1, int y1, int z1, int x2, int y2, int z2)	Creates an Iterable that returns all positions in the box specified by the given corners.
static Iterable<BlockPos>	betweenClosed(BlockPos firstPos, BlockPos secondPos)
static Iterable<BlockPos>	betweenClosed(AABB box)
static Stream<BlockPos>	betweenClosedStream(int minX, int minY, int minZ, int maxX, int maxY, int maxZ)
static Stream<BlockPos>	betweenClosedStream(BlockPos firstPos, BlockPos secondPos)
static Stream<BlockPos>	betweenClosedStream(BoundingBox box)
static Stream<BlockPos>	betweenClosedStream(AABB aabb)
static int	breadthFirstTraversal(BlockPos startPos, int radius, int maxBlocks, BiConsumer<BlockPos,Consumer<BlockPos>> childrenGetter, Function<BlockPos,BlockPos.TraversalNodeStatus> action)
Vec3	clampLocationWithin(Vec3 pos)
static BlockPos	containing(double x, double y, double z)
static BlockPos	containing(Position position)
BlockPos	cross(Vec3i vector)	Calculate the cross product of this and the given Vector
BlockPos	east()
BlockPos	east(int p_122031_)
static Optional<BlockPos>	findClosestMatch(BlockPos pos, int width, int height, Predicate<BlockPos> posFilter)
Vec3	getBottomCenter()
Vec3	getCenter()
static long	getFlatIndex(long packedPos)
static int	getX(long packedPos)
static int	getY(long packedPos)
static int	getZ(long packedPos)
BlockPos	immutable()
static BlockPos	max(BlockPos pos1, BlockPos pos2)
static BlockPos	min(BlockPos pos1, BlockPos pos2)
BlockPos	multiply(int p_175263_)
BlockPos.MutableBlockPos	mutable()
BlockPos	north()
BlockPos	north(int p_122014_)
static BlockPos	of(long packedPos)
BlockPos	offset(int p_121973_, int p_121974_, int p_121975_)
static long	offset(long pos, int dx, int dy, int dz)
static long	offset(long pos, Direction direction)
BlockPos	offset(Vec3i p_121956_)
static Iterable<BlockPos>	randomBetweenClosed(RandomSource random, int amount, int minX, int minY, int minZ, int maxX, int maxY, int maxZ)
static Iterable<BlockPos>	randomInCube(RandomSource random, int amount, BlockPos center, int radius)
BlockPos	relative(Direction direction)
BlockPos	relative(Direction.Axis p_121943_, int p_121944_)
BlockPos	relative(Direction direction, int p_121949_)	Offsets this Vector by the given distance in the specified direction.
BlockPos	rotate(Rotation rotation)
BlockPos	south()
BlockPos	south(int distance)
static Iterable<BlockPos.MutableBlockPos>	spiralAround(BlockPos center, int size, Direction rotationDirection, Direction expansionDirection)
static Stream<BlockPos>	squareOutSouthEast(BlockPos pos)	Deprecated.
BlockPos	subtract(Vec3i vector)
BlockPos	west()
BlockPos	west(int p_122026_)
static Iterable<BlockPos>	withinManhattan(BlockPos pos, int xSize, int ySize, int zSize)
static Stream<BlockPos>	withinManhattanStream(BlockPos pos, int xSize, int ySize, int zSize)	Returns a stream of positions in a box shape, ordered by closest to furthest.

Methods inherited from class net.minecraft.core.Vec3i

closerThan, closerToCenterThan, compareTo, distChessboard, distManhattan, distSqr, distToCenterSqr, distToCenterSqr, distToLowCornerSqr, equals, get, getX, getY, getZ, hashCode, offsetCodec, setX, setY, setZ, toShortString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CODEC

public static final com.mojang.serialization.Codec<BlockPos> CODEC

STREAM_CODEC

public static final StreamCodec<io.netty.buffer.ByteBuf,BlockPos> STREAM_CODEC

LOGGER

private static final org.slf4j.Logger LOGGER

ZERO

public static final BlockPos ZERO

An immutable BlockPos with zero as all coordinates.

PACKED_HORIZONTAL_LENGTH

public static final int PACKED_HORIZONTAL_LENGTH

PACKED_Y_LENGTH

public static final int PACKED_Y_LENGTH

PACKED_X_MASK

private static final long PACKED_X_MASK

PACKED_Y_MASK

private static final long PACKED_Y_MASK

PACKED_Z_MASK

private static final long PACKED_Z_MASK

Y_OFFSET

private static final int Y_OFFSET

See Also:

• Constant Field Values

Z_OFFSET

private static final int Z_OFFSET

X_OFFSET

private static final int X_OFFSET

MAX_HORIZONTAL_COORDINATE

public static final int MAX_HORIZONTAL_COORDINATE

Constructor Details

BlockPos

public BlockPos(int x,
 int y,
 int z)

BlockPos

public BlockPos(Vec3i vector)

Method Details

offset

public static long offset(long pos,
 Direction direction)

offset

public static long offset(long pos,
 int dx,
 int dy,
 int dz)

getX

public static int getX(long packedPos)

getY

public static int getY(long packedPos)

getZ

public static int getZ(long packedPos)

of

public static BlockPos of(long packedPos)

containing

public static BlockPos containing(double x,
 double y,
 double z)

containing

public static BlockPos containing(Position position)

min

public static BlockPos min(BlockPos pos1,
 BlockPos pos2)

max

public static BlockPos max(BlockPos pos1,
 BlockPos pos2)

asLong

public long asLong()

asLong

public static long asLong(int x,
 int y,
 int z)

getFlatIndex

public static long getFlatIndex(long packedPos)

offset

public BlockPos offset(int p_121973_,
 int p_121974_,
 int p_121975_)

Overrides:

offset in class Vec3i

getCenter

public Vec3 getCenter()

getBottomCenter

public Vec3 getBottomCenter()

offset

public BlockPos offset(Vec3i p_121956_)

Overrides:

offset in class Vec3i

subtract

public BlockPos subtract(Vec3i vector)

Overrides:

subtract in class Vec3i

multiply

public BlockPos multiply(int p_175263_)

Overrides:

multiply in class Vec3i

above

public BlockPos above()

Overrides:

above in class Vec3i

above

public BlockPos above(int p_121972_)

Description copied from class: Vec3i

Offset this vector upwards by the given distance.

Overrides:

above in class Vec3i

below

public BlockPos below()

Overrides:

below in class Vec3i

below

public BlockPos below(int p_122000_)

Description copied from class: Vec3i

Offset this vector downwards by the given distance.

Overrides:

below in class Vec3i

north

public BlockPos north()

Overrides:

north in class Vec3i

north

public BlockPos north(int p_122014_)

Overrides:

north in class Vec3i

south

public BlockPos south()

Overrides:

south in class Vec3i

south

public BlockPos south(int distance)

Overrides:

south in class Vec3i

west

public BlockPos west()

Overrides:

west in class Vec3i

west

public BlockPos west(int p_122026_)

Overrides:

west in class Vec3i

east

public BlockPos east()

Overrides:

east in class Vec3i

east

public BlockPos east(int p_122031_)

Overrides:

east in class Vec3i

relative

public BlockPos relative(Direction direction)

Overrides:

relative in class Vec3i

relative

public BlockPos relative(Direction direction,
 int p_121949_)

Description copied from class: Vec3i

Offsets this Vector by the given distance in the specified direction.

Overrides:

relative in class Vec3i

relative

public BlockPos relative(Direction.Axis p_121943_,
 int p_121944_)

Overrides:

relative in class Vec3i

rotate

public BlockPos rotate(Rotation rotation)

cross

public BlockPos cross(Vec3i vector)

Description copied from class: Vec3i

Calculate the cross product of this and the given Vector

Overrides:

cross in class Vec3i

atY

public BlockPos atY(int y)

immutable

public BlockPos immutable()

mutable

public BlockPos.MutableBlockPos mutable()

clampLocationWithin

public Vec3 clampLocationWithin(Vec3 pos)

randomInCube

public static Iterable<BlockPos> randomInCube(RandomSource random,
 int amount,
 BlockPos center,
 int radius)

squareOutSouthEast

@Deprecated
public static Stream<BlockPos> squareOutSouthEast(BlockPos pos)

Deprecated.

randomBetweenClosed

public static Iterable<BlockPos> randomBetweenClosed(RandomSource random,
 int amount,
 int minX,
 int minY,
 int minZ,
 int maxX,
 int maxY,
 int maxZ)

withinManhattan

public static Iterable<BlockPos> withinManhattan(BlockPos pos,
 int xSize,
 int ySize,
 int zSize)

findClosestMatch

public static Optional<BlockPos> findClosestMatch(BlockPos pos,
 int width,
 int height,
 Predicate<BlockPos> posFilter)

withinManhattanStream

public static Stream<BlockPos> withinManhattanStream(BlockPos pos,
 int xSize,
 int ySize,
 int zSize)

Returns a stream of positions in a box shape, ordered by closest to furthest. Returns by definition the given position as first element in the stream.

betweenClosed

public static Iterable<BlockPos> betweenClosed(AABB box)

betweenClosed

public static Iterable<BlockPos> betweenClosed(BlockPos firstPos,
 BlockPos secondPos)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(BlockPos firstPos,
 BlockPos secondPos)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(BoundingBox box)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(AABB aabb)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(int minX,
 int minY,
 int minZ,
 int maxX,
 int maxY,
 int maxZ)

betweenClosed

public static Iterable<BlockPos> betweenClosed(int x1,
 int y1,
 int z1,
 int x2,
 int y2,
 int z2)

Creates an Iterable that returns all positions in the box specified by the given corners. Coordinates must be in order. e.g. x1 invalid input: '<'= x2. This method uses MutableBlockPos instead of regular BlockPos, which grants better performance. However, the resulting BlockPos instances can only be used inside the iteration loop (as otherwise the value will change), unless

invalid reference

#toImmutable()

is called. This method is ideal for searching large areas and only storing a few locations.

See Also:

• betweenClosed(BlockPos, BlockPos)
• betweenClosed(int, int, int, int, int, int)

spiralAround

public static Iterable<BlockPos.MutableBlockPos> spiralAround(BlockPos center,
 int size,
 Direction rotationDirection,
 Direction expansionDirection)

breadthFirstTraversal

public static int breadthFirstTraversal(BlockPos startPos,
 int radius,
 int maxBlocks,
 BiConsumer<BlockPos,Consumer<BlockPos>> childrenGetter,
 Function<BlockPos,BlockPos.TraversalNodeStatus> action)