BlockPos - CraftTweaker Documentation

Version:

Language:

Home Commands Examples Getting Started With Scripts Global Keywords

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.

ZenScript
 Copy
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

containing

Name: containing

Return Type: BlockPos

ZenScript
 Copy
BlockPos.containing(x as double, y as double, z as double) as BlockPos

Parameter	Type
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.

ZenScript
 Copy
new BlockPos(vector as Vec3) as BlockPos
new BlockPos(new Vec3(0, 1, 2));

Parameter	Type	Description
Parameter vector	Type Vec3	Description The vector to copy the values of.

Creates a new BlockPos using the provided values.

ZenScript
 Copy
new BlockPos(x as int, y as int, z as int) as BlockPos
new BlockPos(0, 1, 2);

Parameter	Type	Description
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

above

Name: above

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.above() as BlockPos

myBlockPos.above();

above

Name: above

Return Type: BlockPos

ZenScript
 Copy
BlockPos.above(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int

asImmutable

Name: asImmutable

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.asImmutable() as BlockPos

myBlockPos.asImmutable();

asLong

Name: asLong

Return Type: long

ZenScript
 Copy
// BlockPos.asLong() as long

myBlockPos.asLong();

asMutable

Name: asMutable

Return Type: MutableBlockPos

ZenScript
 Copy
// BlockPos.asMutable() as MutableBlockPos

myBlockPos.asMutable();

atY

Name: atY

Return Type: BlockPos

ZenScript
 Copy
BlockPos.atY(value as int) as BlockPos

Parameter	Type
Parameter value	Type int

below

Name: below

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.below() as BlockPos

myBlockPos.below();

below

Name: below

Return Type: BlockPos

ZenScript
 Copy
BlockPos.below(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int

cross

Name: cross

Return Type: BlockPos

ZenScript
 Copy
BlockPos.cross(other as Vec3i) as BlockPos

Parameter	Type
Parameter other	Type Vec3i

east

Name: east

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.east() as BlockPos

myBlockPos.east();

east

Name: east

Return Type: BlockPos

ZenScript
 Copy
BlockPos.east(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int

multiply

Name: multiply

Return Type: BlockPos

ZenScript
 Copy
BlockPos.multiply(scalar as int) as BlockPos

Parameter	Type
Parameter scalar	Type int

north

Name: north

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.north() as BlockPos

myBlockPos.north();

north

Name: north

Return Type: BlockPos

ZenScript
 Copy
BlockPos.north(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int

offset

Name: offset

Return Type: BlockPos

ZenScript
 Copy
BlockPos.offset(other as Vec3i) as BlockPos

Parameter	Type
Parameter other	Type Vec3i

offset

Name: offset

Return Type: BlockPos

ZenScript
 Copy
BlockPos.offset(x as int, y as int, z as int) as BlockPos

Parameter	Type
Parameter x	Type int
Parameter y	Type int
Parameter z	Type int

relative

Name: relative

Return Type: BlockPos

ZenScript
 Copy
BlockPos.relative(direction as Direction) as BlockPos

Parameter	Type
Parameter direction	Type Direction

relative

Name: relative

Return Type: BlockPos

ZenScript
 Copy
BlockPos.relative(axis as Axis, distance as int) as BlockPos

Parameter	Type
Parameter axis	Type Axis
Parameter distance	Type int

relative

Name: relative

Return Type: BlockPos

ZenScript
 Copy
BlockPos.relative(direction as Direction, distance as int) as BlockPos

Parameter	Type
Parameter direction	Type Direction
Parameter distance	Type int

rotate

Name: rotate

Return Type: BlockPos

ZenScript
 Copy
BlockPos.rotate(rotation as Rotation) as BlockPos

Parameter	Type
Parameter rotation	Type Rotation

south

Name: south

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.south() as BlockPos

myBlockPos.south();

south

Name: south

Return Type: BlockPos

ZenScript
 Copy
BlockPos.south(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int

subtract

Name: subtract

Return Type: BlockPos

ZenScript
 Copy
BlockPos.subtract(other as Vec3i) as BlockPos

Parameter	Type
Parameter other	Type Vec3i

west

Name: west

Return Type: BlockPos

ZenScript
 Copy
// BlockPos.west() as BlockPos

myBlockPos.west();

west

Name: west

Return Type: BlockPos

ZenScript
 Copy
BlockPos.west(distance as int) as BlockPos

Parameter	Type
Parameter distance	Type int