Package api.world

Class ImmutableBlockPos

java.lang.Object

api.util.Vec3i

api.world.ImmutableBlockPos

All Implemented Interfaces:

Comparable<Vec3i>

Direct Known Subclasses:

ImmutableBlockPos.VanillaMutableBlockPos

public class ImmutableBlockPos
extends Vec3i

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableBlockPos.VanillaMutableBlockPos

Field Summary

Fields

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

Fields inherited from class api.util.Vec3i

NULL_VECTOR

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class api.util.Vec3i

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

Methods inherited from class java.lang.Object

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

Field Details

ORIGIN

public static final ImmutableBlockPos ORIGIN

The BlockPos with all coordinates 0

Constructor Details

ImmutableBlockPos

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

ImmutableBlockPos

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

ImmutableBlockPos

public ImmutableBlockPos(Entity source)

ImmutableBlockPos

public ImmutableBlockPos(Vec3 source)

ImmutableBlockPos

public ImmutableBlockPos(Vec3i source)

Method Details

add

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

Add the given coordinates to the coordinates of this BlockPosI

add

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

Add the given coordinates to the coordinates of this BlockPosI

add

public ImmutableBlockPos add(Vec3i vec)

Add the given Vector to this BlockPosI

subtract

public ImmutableBlockPos subtract(Vec3i vec)

Subtract the given Vector from this BlockPosI

up

public ImmutableBlockPos up()

Offset this BlockPosI 1 block up

up

public ImmutableBlockPos up(int n)

Offset this BlockPosI n blocks up

down

public ImmutableBlockPos down()

Offset this BlockPosI 1 block down

down

public ImmutableBlockPos down(int n)

Offset this BlockPosI n blocks down

north

public ImmutableBlockPos north()

Offset this BlockPosI 1 block in northern direction

north

public ImmutableBlockPos north(int n)

Offset this BlockPosI n blocks in northern direction

south

public ImmutableBlockPos south()

Offset this BlockPosI 1 block in southern direction

south

public ImmutableBlockPos south(int n)

Offset this BlockPosI n blocks in southern direction

west

public ImmutableBlockPos west()

Offset this BlockPosI 1 block in western direction

west

public ImmutableBlockPos west(int n)

Offset this BlockPosI n blocks in western direction

east

public ImmutableBlockPos east()

Offset this BlockPosI 1 block in eastern direction

east

public ImmutableBlockPos east(int n)

Offset this BlockPosI n blocks in eastern direction

offset

public ImmutableBlockPos offset(EnumFacing facing)

Offset this BlockPosI 1 block in the given direction

offset

public ImmutableBlockPos offset(EnumFacing facing,
 int n)

Offsets this BlockPosI n blocks in the given direction

crossProduct

public ImmutableBlockPos crossProduct(Vec3i vec)

Calculate the cross product of this and the given Vector

Overrides:

crossProduct in class Vec3i

toLong

public long toLong()

Serialize this BlockPosI into a long value

fromLong

public static ImmutableBlockPos fromLong(long serialized)

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

getAllInBox

public static Iterable<ImmutableBlockPos> getAllInBox(ImmutableBlockPos from,
 ImmutableBlockPos to)

getAllInBoxMutable

public static Iterable<ImmutableBlockPos.VanillaMutableBlockPos> getAllInBoxMutable(ImmutableBlockPos from,
 ImmutableBlockPos to)

toString

public String toString()

Overrides:

toString in class Vec3i