BlockPos - CraftTweaker Documentation

Version:

Language:

Home Getting Started With Scripts Commands Examples

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

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	Description
Parameter distance	Type int	Description No Description Provided

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	Description
Parameter value	Type int	Description No Description Provided

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	Description
Parameter distance	Type int	Description No Description Provided

cross

Name: cross

Return Type: BlockPos

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

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	Description
Parameter distance	Type int	Description No Description Provided

multiply

Name: multiply

Return Type: BlockPos

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

Parameter	Type	Description
Parameter scalar	Type int	Description No Description Provided

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	Description
Parameter distance	Type int	Description No Description Provided

offset

Name: offset

Return Type: BlockPos

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

offset

Name: offset

Return Type: BlockPos

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

Parameter	Type	Description
Parameter x	Type double	Description No Description Provided
Parameter y	Type double	Description No Description Provided
Parameter z	Type double	Description No Description Provided

offset

Name: offset

Return Type: BlockPos

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

Parameter	Type	Description
Parameter x	Type int	Description No Description Provided
Parameter y	Type int	Description No Description Provided
Parameter z	Type int	Description No Description Provided

relative

Name: relative

Return Type: BlockPos

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

Parameter	Type	Description
Parameter direction	Type Direction	Description No Description Provided

relative

Name: relative

Return Type: BlockPos

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

Parameter	Type	Description
Parameter axis	Type Axis	Description No Description Provided
Parameter distance	Type int	Description No Description Provided

relative

Name: relative

Return Type: BlockPos

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

Parameter	Type	Description
Parameter direction	Type Direction	Description No Description Provided
Parameter distance	Type int	Description No Description Provided

rotate

Name: rotate

Return Type: BlockPos

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

Parameter	Type	Description
Parameter rotation	Type Rotation	Description No Description Provided

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	Description
Parameter distance	Type int	Description No Description Provided

subtract

Name: subtract

Return Type: BlockPos

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

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	Description
Parameter distance	Type int	Description No Description Provided