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
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 vec3i)

Method Summary

Modifier and Type	Method	Description
BlockPos	above()
BlockPos	above(int steps)	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 steps)	Offset this vector downwards by the given distance.
static Iterable<BlockPos>	betweenClosed(int minX, int minY, int minZ, int maxX, int maxY, int maxZ)	Creates an Iterable that returns all positions in the box specified by the given corners.
static Iterable<BlockPos>	betweenClosed(BlockPos a, BlockPos b)
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 a, BlockPos b)
static Stream<BlockPos>	betweenClosedStream(BoundingBox boundingBox)
static Stream<BlockPos>	betweenClosedStream(AABB box)
static Iterable<BlockPos>	betweenCornersInDirection(int firstCornerX, int firstCornerY, int firstCornerZ, int secondCornerX, int secondCornerY, int secondCornerZ, Vec3 direction)
static Iterable<BlockPos>	betweenCornersInDirection(BlockPos firstCorner, BlockPos secondCorner, Vec3 direction)
static Iterable<BlockPos>	betweenCornersInDirection(AABB aabb, Vec3 direction)
static int	breadthFirstTraversal(BlockPos startPos, int maxDepth, int maxCount, BiConsumer<BlockPos, Consumer<BlockPos>> neighbourProvider, Function<BlockPos, BlockPos.TraversalNodeStatus> nodeProcessor)
Vec3	clampLocationWithin(Vec3 location)
static BlockPos	containing(double x, double y, double z)
static BlockPos	containing(Position pos)
BlockPos	cross(Vec3i upVector)	Calculate the cross product of this and the given Vector
BlockPos	east()
BlockPos	east(int steps)
static Optional<BlockPos>	findClosestMatch(BlockPos startPos, int horizontalSearchRadius, int verticalSearchRadius, Predicate<BlockPos> predicate)
Vec3	getBottomCenter()
Vec3	getCenter()
static long	getFlatIndex(long neighborBlockNode)
static int	getX(long blockNode)
static int	getY(long blockNode)
static int	getZ(long blockNode)
BlockPos	immutable()
static BlockPos	max(BlockPos a, BlockPos b)
static BlockPos	min(BlockPos a, BlockPos b)
BlockPos	multiply(int scale)
BlockPos.MutableBlockPos	mutable()
BlockPos	north()
BlockPos	north(int steps)
static BlockPos	of(long blockNode)
BlockPos	offset(int x, int y, int z)
static long	offset(long blockNode, int stepX, int stepY, int stepZ)
static long	offset(long blockNode, Direction offset)
BlockPos	offset(Vec3i vec)
static Iterable<BlockPos>	randomBetweenClosed(RandomSource random, int limit, int minX, int minY, int minZ, int maxX, int maxY, int maxZ)
static Iterable<BlockPos>	randomInCube(RandomSource random, int limit, BlockPos center, int sizeToScanInAllDirections)
BlockPos	relative(Direction direction)
BlockPos	relative(Direction.Axis axis, int steps)
BlockPos	relative(Direction direction, int steps)	Offsets this Vector by the given distance in the specified direction.
BlockPos	rotate(Rotation rotation)
BlockPos	south()
BlockPos	south(int steps)
static Iterable<BlockPos.MutableBlockPos>	spiralAround(BlockPos center, int radius, Direction firstDirection, Direction secondDirection)
static Stream<BlockPos>	squareOutSouthEast(BlockPos from)	Deprecated.
BlockPos	subtract(Vec3i vec)
BlockPos	west()
BlockPos	west(int steps)
static Iterable<BlockPos>	withinManhattan(BlockPos origin, int reachX, int reachY, int reachZ)
static Stream<BlockPos>	withinManhattanStream(BlockPos origin, int reachX, int reachY, int reachZ)	Returns a stream of positions in a box shape, ordered by closest to furthest.

Methods inherited from class Vec3i

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

Methods inherited from class 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

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 vec3i)

Method Details

offset

public static long offset(long blockNode,
 Direction offset)

offset

public static long offset(long blockNode,
 int stepX,
 int stepY,
 int stepZ)

getX

public static int getX(long blockNode)

getY

public static int getY(long blockNode)

getZ

public static int getZ(long blockNode)

of

public static BlockPos of(long blockNode)

containing

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

containing

public static BlockPos containing(Position pos)

min

public static BlockPos min(BlockPos a,
 BlockPos b)

max

public static BlockPos max(BlockPos a,
 BlockPos b)

asLong

public long asLong()

asLong

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

getFlatIndex

public static long getFlatIndex(long neighborBlockNode)

offset

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

Overrides:

offset in class Vec3i

getCenter

public Vec3 getCenter()

getBottomCenter

public Vec3 getBottomCenter()

offset

public BlockPos offset(Vec3i vec)

Overrides:

offset in class Vec3i

subtract

public BlockPos subtract(Vec3i vec)

Overrides:

subtract in class Vec3i

multiply

public BlockPos multiply(int scale)

Overrides:

multiply in class Vec3i

above

public BlockPos above()

Overrides:

above in class Vec3i

above

public BlockPos above(int steps)

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 steps)

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 steps)

Overrides:

north in class Vec3i

south

public BlockPos south()

Overrides:

south in class Vec3i

south

public BlockPos south(int steps)

Overrides:

south in class Vec3i

west

public BlockPos west()

Overrides:

west in class Vec3i

west

public BlockPos west(int steps)

Overrides:

west in class Vec3i

east

public BlockPos east()

Overrides:

east in class Vec3i

east

public BlockPos east(int steps)

Overrides:

east in class Vec3i

relative

public BlockPos relative(Direction direction)

Overrides:

relative in class Vec3i

relative

public BlockPos relative(Direction direction,
 int steps)

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 axis,
 int steps)

Overrides:

relative in class Vec3i

rotate

public BlockPos rotate(Rotation rotation)

cross

public BlockPos cross(Vec3i upVector)

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 location)

randomInCube

public static Iterable<BlockPos> randomInCube(RandomSource random,
 int limit,
 BlockPos center,
 int sizeToScanInAllDirections)

squareOutSouthEast

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

Deprecated.

randomBetweenClosed

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

withinManhattan

public static Iterable<BlockPos> withinManhattan(BlockPos origin,
 int reachX,
 int reachY,
 int reachZ)

findClosestMatch

public static Optional<BlockPos> findClosestMatch(BlockPos startPos,
 int horizontalSearchRadius,
 int verticalSearchRadius,
 Predicate<BlockPos> predicate)

withinManhattanStream

public static Stream<BlockPos> withinManhattanStream(BlockPos origin,
 int reachX,
 int reachY,
 int reachZ)

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 a,
 BlockPos b)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(BlockPos a,
 BlockPos b)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(BoundingBox boundingBox)

betweenClosedStream

public static Stream<BlockPos> betweenClosedStream(AABB box)

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 minX,
 int minY,
 int minZ,
 int maxX,
 int maxY,
 int maxZ)

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 radius,
 Direction firstDirection,
 Direction secondDirection)

breadthFirstTraversal

public static int breadthFirstTraversal(BlockPos startPos,
 int maxDepth,
 int maxCount,
 BiConsumer<BlockPos, Consumer<BlockPos>> neighbourProvider,
 Function<BlockPos, BlockPos.TraversalNodeStatus> nodeProcessor)

betweenCornersInDirection

public static Iterable<BlockPos> betweenCornersInDirection(AABB aabb,
 Vec3 direction)

betweenCornersInDirection

public static Iterable<BlockPos> betweenCornersInDirection(BlockPos firstCorner,
 BlockPos secondCorner,
 Vec3 direction)

betweenCornersInDirection

public static Iterable<BlockPos> betweenCornersInDirection(int firstCornerX,
 int firstCornerY,
 int firstCornerZ,
 int secondCornerX,
 int secondCornerY,
 int secondCornerZ,
 Vec3 direction)