BlockPos

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

script.zs
import crafttweaker.api.util.math.BlockPos;

Extending Vec3i

BlockPos extends Vec3i. That means all methods available in Vec3i are also available in BlockPos

Static Methods

Return Type: BlockPos

script.zs
BlockPos.containing(x as double, y as double, z as double) as BlockPos
ParameterType
Parameter
x
Type
double
Parameter
y
Type
double
Parameter
z
Type
double

Constructors

Creates a new BlockPos using the values of the given vector. Note, the values will be floored down, providing 0.85 is the same as providing 0.

script.zs
new BlockPos(vector as Vec3) as BlockPos
new BlockPos(new Vec3(0, 1, 2));
ParameterTypeDescription
Parameter
vector
Type
Vec3
Description
The vector to copy the values of.

Creates a new BlockPos using the provided values.

script.zs
new BlockPos(x as int, y as int, z as int) as BlockPos
new BlockPos(0, 1, 2);
ParameterTypeDescription
Parameter
x
Type
int
Description
The x value of the blockpos
Parameter
y
Type
int
Description
The y value of the blockpos
Parameter
z
Type
int
Description
The z value of the blockpos

Methods

Return Type: BlockPos

script.zs
// BlockPos.above() as BlockPos
myBlockPos.above();

Return Type: BlockPos

script.zs
BlockPos.above(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
// BlockPos.asImmutable() as BlockPos
myBlockPos.asImmutable();

Return Type: long

script.zs
// BlockPos.asLong() as long
myBlockPos.asLong();

Return Type: MutableBlockPos

script.zs
// BlockPos.asMutable() as MutableBlockPos
myBlockPos.asMutable();

Return Type: BlockPos

script.zs
BlockPos.atY(value as int) as BlockPos
ParameterType
Parameter
value
Type
int

Return Type: BlockPos

script.zs
// BlockPos.below() as BlockPos
myBlockPos.below();

Return Type: BlockPos

script.zs
BlockPos.below(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.cross(other as Vec3i) as BlockPos
ParameterType
Parameter
other
Type
Vec3i

Return Type: BlockPos

script.zs
// BlockPos.east() as BlockPos
myBlockPos.east();

Return Type: BlockPos

script.zs
BlockPos.east(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.multiply(scalar as int) as BlockPos
ParameterType
Parameter
scalar
Type
int

Return Type: BlockPos

script.zs
// BlockPos.north() as BlockPos
myBlockPos.north();

Return Type: BlockPos

script.zs
BlockPos.north(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.offset(other as Vec3i) as BlockPos
ParameterType
Parameter
other
Type
Vec3i

Return Type: BlockPos

script.zs
BlockPos.offset(x as int, y as int, z as int) as BlockPos
ParameterType
Parameter
x
Type
int
Parameter
y
Type
int
Parameter
z
Type
int

Return Type: BlockPos

script.zs
BlockPos.relative(direction as Direction) as BlockPos
ParameterType
Parameter
direction
Type
Direction

Return Type: BlockPos

script.zs
BlockPos.relative(axis as Axis, distance as int) as BlockPos
ParameterType
Parameter
axis
Type
Axis
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.relative(direction as Direction, distance as int) as BlockPos
ParameterType
Parameter
direction
Type
Direction
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.rotate(rotation as Rotation) as BlockPos
ParameterType
Parameter
rotation
Type
Rotation

Return Type: BlockPos

script.zs
// BlockPos.south() as BlockPos
myBlockPos.south();

Return Type: BlockPos

script.zs
BlockPos.south(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int

Return Type: BlockPos

script.zs
BlockPos.subtract(other as Vec3i) as BlockPos
ParameterType
Parameter
other
Type
Vec3i

Return Type: BlockPos

script.zs
// BlockPos.west() as BlockPos
myBlockPos.west();

Return Type: BlockPos

script.zs
BlockPos.west(distance as int) as BlockPos
ParameterType
Parameter
distance
Type
int