net.minecraft.util

Class BlockPos

java.lang.Object

net.minecraft.util.Vec3i

net.minecraft.util.BlockPos

All Implemented Interfaces:

java.lang.Comparable<Vec3i>

Direct Known Subclasses:

BlockPos.MutableBlockPos, Teleporter.PortalPosition

public class BlockPos
extends Vec3i

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockPos.MutableBlockPos

Field Summary

Fields

Modifier and Type	Field and Description
static BlockPos	ORIGIN The BlockPos with all coordinates 0

Fields inherited from class net.minecraft.util.Vec3i

NULL_VECTOR

Constructor Summary

Constructors

Constructor and Description
BlockPos(double x, double y, double z)
BlockPos(Entity source)
BlockPos(int x, int y, int z)
BlockPos(Vec3 source)
BlockPos(Vec3i source)

Method Summary

Modifier and Type	Method and Description
BlockPos	add(double x, double y, double z) Add the given coordinates to the coordinates of this BlockPos
BlockPos	add(int x, int y, int z) Add the given coordinates to the coordinates of this BlockPos
BlockPos	add(Vec3i vec) Add the given Vector to this BlockPos
BlockPos	crossProduct(Vec3i vec) Calculate the cross product of this and the given Vector
BlockPos	down() Offset this BlockPos 1 block down
BlockPos	down(int n) Offset this BlockPos n blocks down
BlockPos	east() Offset this BlockPos 1 block in eastern direction
BlockPos	east(int n) Offset this BlockPos n blocks in eastern direction
static BlockPos	fromLong(long serialized) Create a BlockPos from a serialized long value (created by toLong)
static java.lang.Iterable<BlockPos>	getAllInBox(BlockPos from, BlockPos to)
static java.lang.Iterable<BlockPos.MutableBlockPos>	getAllInBoxMutable(BlockPos from, BlockPos to)
BlockPos	getImmutable() Returns a version of this BlockPos that is guaranteed to be Immutable.
BlockPos	north() Offset this BlockPos 1 block in northern direction
BlockPos	north(int n) Offset this BlockPos n blocks in northern direction
BlockPos	offset(EnumFacing facing) Offset this BlockPos 1 block in the given direction
BlockPos	offset(EnumFacing facing, int n) Offsets this BlockPos n blocks in the given direction
BlockPos	south() Offset this BlockPos 1 block in southern direction
BlockPos	south(int n) Offset this BlockPos n blocks in southern direction
BlockPos	subtract(Vec3i vec) Subtract the given Vector from this BlockPos
long	toLong() Serialize this BlockPos into a long value
BlockPos	up() Offset this BlockPos 1 block up
BlockPos	up(int n) Offset this BlockPos n blocks up
BlockPos	west() Offset this BlockPos 1 block in western direction
BlockPos	west(int n) Offset this BlockPos n blocks in western direction

Methods inherited from class net.minecraft.util.Vec3i

compareTo, distanceSq, distanceSq, distanceSqToCenter, equals, getX, getY, getZ, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN

public static final BlockPos ORIGIN

The BlockPos with all coordinates 0

Constructor Detail

BlockPos

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

BlockPos

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

BlockPos

public BlockPos(Entity source)

BlockPos

public BlockPos(Vec3 source)

BlockPos

public BlockPos(Vec3i source)

Method Detail

add

public BlockPos add(double x,
                    double y,
                    double z)

Add the given coordinates to the coordinates of this BlockPos

add

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

Add the given coordinates to the coordinates of this BlockPos

add

public BlockPos add(Vec3i vec)

Add the given Vector to this BlockPos

subtract

public BlockPos subtract(Vec3i vec)

Subtract the given Vector from this BlockPos

up

public BlockPos up()

Offset this BlockPos 1 block up

up

public BlockPos up(int n)

Offset this BlockPos n blocks up

down

public BlockPos down()

Offset this BlockPos 1 block down

down

public BlockPos down(int n)

Offset this BlockPos n blocks down

north

public BlockPos north()

Offset this BlockPos 1 block in northern direction

north

public BlockPos north(int n)

Offset this BlockPos n blocks in northern direction

south

public BlockPos south()

Offset this BlockPos 1 block in southern direction

south

public BlockPos south(int n)

Offset this BlockPos n blocks in southern direction

west

public BlockPos west()

Offset this BlockPos 1 block in western direction

west

public BlockPos west(int n)

Offset this BlockPos n blocks in western direction

east

public BlockPos east()

Offset this BlockPos 1 block in eastern direction

east

public BlockPos east(int n)

Offset this BlockPos n blocks in eastern direction

offset

public BlockPos offset(EnumFacing facing)

Offset this BlockPos 1 block in the given direction

offset

public BlockPos offset(EnumFacing facing,
                       int n)

Offsets this BlockPos n blocks in the given direction

crossProduct

public BlockPos crossProduct(Vec3i vec)

Calculate the cross product of this and the given Vector

Overrides:

crossProduct in class Vec3i

toLong

public long toLong()

Serialize this BlockPos into a long value

fromLong

public static BlockPos fromLong(long serialized)

Create a BlockPos from a serialized long value (created by toLong)

getAllInBox

public static java.lang.Iterable<BlockPos> getAllInBox(BlockPos from,
                                                       BlockPos to)

getAllInBoxMutable

public static java.lang.Iterable<BlockPos.MutableBlockPos> getAllInBoxMutable(BlockPos from,
                                                                              BlockPos to)

getImmutable

public BlockPos getImmutable()

Returns a version of this BlockPos that is guaranteed to be Immutable. In most cases this will return 'this', but if 'this' is an instance of MutableBlockPos it will return a new instance of BlockPos with the same values. When storing a parameter given to you for an extended period of time, make sure you use this in case the value is changed internally.

Returns:

An immutable BlockPos.