Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AABB AxisCycle BlockPos FrontAndTop Matrix3f MutableBlockPos OctahedralGroup Quaternionf Quaternionfc Random RandomSource Rotation Vec3 Vec3i Vector3f Vector3fc
BlockHitResult EntityHitResult GameProfile GlobalPos HitResult HitResultType InteractionHand Many NameUtil Pair Position StringRepresentable
BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler
Previous
Matrix3f OctahedralGroup
Next

MutableBlockPos

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

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

Extends

MutableBlockPos extends BlockPos.

Implements

Undocumented Interfaces

Comparable<Vec3i>

Members

above
above() as BlockPos
script.zs
// MutableBlockPos.above() as BlockPos;
myMutableBlockPos.above();

Return Type: BlockPos

above(distance as int) as BlockPos
script.zs
// MutableBlockPos.above(distance as int) as BlockPos;
myMutableBlockPos.above(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

above() as Vec3i
script.zs
// MutableBlockPos.above() as Vec3i;
myMutableBlockPos.above();

Return Type: Vec3i

above(distance as int) as Vec3i
script.zs
// MutableBlockPos.above(distance as int) as Vec3i;
myMutableBlockPos.above(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

asImmutable
asImmutable() as BlockPos
script.zs
// MutableBlockPos.asImmutable() as BlockPos;
myMutableBlockPos.asImmutable();

Return Type: BlockPos

asLong
asLong() as long
script.zs
// MutableBlockPos.asLong() as long;
myMutableBlockPos.asLong();

Return Type: long

asMutable
asMutable() as MutableBlockPos
script.zs
// MutableBlockPos.asMutable() as MutableBlockPos;
myMutableBlockPos.asMutable();

Return Type: MutableBlockPos

atY
atY(value as int) as BlockPos
script.zs
// MutableBlockPos.atY(value as int) as BlockPos;
myMutableBlockPos.atY(myInt);

Parameters:

value Type: int

Return Type: BlockPos

below
below() as BlockPos
script.zs
// MutableBlockPos.below() as BlockPos;
myMutableBlockPos.below();

Return Type: BlockPos

below(distance as int) as BlockPos
script.zs
// MutableBlockPos.below(distance as int) as BlockPos;
myMutableBlockPos.below(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

below() as Vec3i
script.zs
// MutableBlockPos.below() as Vec3i;
myMutableBlockPos.below();

Return Type: Vec3i

below(distance as int) as Vec3i
script.zs
// MutableBlockPos.below(distance as int) as Vec3i;
myMutableBlockPos.below(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

clamp
clamp(axis as Axis, min as int, max as int) as MutableBlockPos
script.zs
// MutableBlockPos.clamp(axis as Axis, min as int, max as int) as MutableBlockPos;
myMutableBlockPos.clamp(myAxis, myInt, myInt);

Parameters:

axis Type: Axis
min Type: int
max Type: int

Return Type: MutableBlockPos

closerThan
closerThan(other as Vec3i, maxDistance as double) as bool
script.zs
// MutableBlockPos.closerThan(other as Vec3i, maxDistance as double) as bool;
myMutableBlockPos.closerThan(myVec3i, myDouble);

Parameters:

other Type: Vec3i
maxDistance Type: double

Return Type: bool

compareTo
compareTo(other as Vec3i) as int
script.zs
// MutableBlockPos.compareTo(other as Vec3i) as int;
myMutableBlockPos.compareTo(myVec3i);

Parameters:

other Type: Vec3i

Return Type: int

containing
static containing(x as double, y as double, z as double) as BlockPos
script.zs
// MutableBlockPos.containing(x as double, y as double, z as double) as BlockPos;
MutableBlockPos.containing(myDouble, myDouble, myDouble);

Parameters:

x Type: double
y Type: double
z Type: double

Return Type: BlockPos

static containing(position as Position) as BlockPos
script.zs
// MutableBlockPos.containing(position as Position) as BlockPos;
MutableBlockPos.containing(myPosition);

Parameters:

position Type: Position

Return Type: BlockPos

cross
cross(other as Vec3i) as BlockPos
script.zs
// MutableBlockPos.cross(other as Vec3i) as BlockPos;
myMutableBlockPos.cross(myVec3i);

Parameters:

other Type: Vec3i

Return Type: BlockPos

cross(other as Vec3i) as Vec3i
script.zs
// MutableBlockPos.cross(other as Vec3i) as Vec3i;
myMutableBlockPos.cross(myVec3i);

Parameters:

other Type: Vec3i

Return Type: Vec3i

distManhattan
distManhattan(other as Vec3i) as int
script.zs
// MutableBlockPos.distManhattan(other as Vec3i) as int;
myMutableBlockPos.distManhattan(myVec3i);

Parameters:

other Type: Vec3i

Return Type: int

distSqr
distSqr(other as Vec3i) as double
script.zs
// MutableBlockPos.distSqr(other as Vec3i) as double;
myMutableBlockPos.distSqr(myVec3i);

Parameters:

other Type: Vec3i

Return Type: double

distToCenterSqr
distToCenterSqr(position as Position) as double
script.zs
// MutableBlockPos.distToCenterSqr(position as Position) as double;
myMutableBlockPos.distToCenterSqr(myPosition);

Parameters:

position Type: Position

Return Type: double

distToCenterSqr(x as double, y as double, z as double) as double
script.zs
// MutableBlockPos.distToCenterSqr(x as double, y as double, z as double) as double;
myMutableBlockPos.distToCenterSqr(myDouble, myDouble, myDouble);

Parameters:

x Type: double
y Type: double
z Type: double

Return Type: double

east
east() as BlockPos
script.zs
// MutableBlockPos.east() as BlockPos;
myMutableBlockPos.east();

Return Type: BlockPos

east(distance as int) as BlockPos
script.zs
// MutableBlockPos.east(distance as int) as BlockPos;
myMutableBlockPos.east(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

east() as Vec3i
script.zs
// MutableBlockPos.east() as Vec3i;
myMutableBlockPos.east();

Return Type: Vec3i

east(distance as int) as Vec3i
script.zs
// MutableBlockPos.east(distance as int) as Vec3i;
myMutableBlockPos.east(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

getValue
getValue(axis as Axis) as int
script.zs
// MutableBlockPos.getValue(axis as Axis) as int;
myMutableBlockPos.getValue(myAxis);

Parameters:

axis Type: Axis

Return Type: int

move
move(direction as Direction) as MutableBlockPos
script.zs
// MutableBlockPos.move(direction as Direction) as MutableBlockPos;
myMutableBlockPos.move(myDirection);

Parameters:

direction Type: Direction

Return Type: MutableBlockPos

move(direction as Direction, distance as int) as MutableBlockPos
script.zs
// MutableBlockPos.move(direction as Direction, distance as int) as MutableBlockPos;
myMutableBlockPos.move(myDirection, myInt);

Parameters:

direction Type: Direction
distance Type: int

Return Type: MutableBlockPos

move(x as int, y as int, z as int) as MutableBlockPos
script.zs
// MutableBlockPos.move(x as int, y as int, z as int) as MutableBlockPos;
myMutableBlockPos.move(myInt, myInt, myInt);

Parameters:

x Type: int
y Type: int
z Type: int

Return Type: MutableBlockPos

move(other as Vec3i) as MutableBlockPos
script.zs
// MutableBlockPos.move(other as Vec3i) as MutableBlockPos;
myMutableBlockPos.move(myVec3i);

Parameters:

other Type: Vec3i

Return Type: MutableBlockPos

multiply
multiply(scalar as int) as BlockPos
script.zs
// MutableBlockPos.multiply(scalar as int) as BlockPos;
myMutableBlockPos.multiply(myInt);

Parameters:

scalar Type: int

Return Type: BlockPos

multiply(scalar as int) as Vec3i
script.zs
// MutableBlockPos.multiply(scalar as int) as Vec3i;
myMutableBlockPos.multiply(myInt);

Parameters:

scalar Type: int

Return Type: Vec3i

mutable
mutable() as MutableBlockPos
script.zs
// MutableBlockPos.mutable() as MutableBlockPos;
myMutableBlockPos.mutable();

Return Type: MutableBlockPos

north
north() as BlockPos
script.zs
// MutableBlockPos.north() as BlockPos;
myMutableBlockPos.north();

Return Type: BlockPos

north(distance as int) as BlockPos
script.zs
// MutableBlockPos.north(distance as int) as BlockPos;
myMutableBlockPos.north(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

north() as Vec3i
script.zs
// MutableBlockPos.north() as Vec3i;
myMutableBlockPos.north();

Return Type: Vec3i

north(distance as int) as Vec3i
script.zs
// MutableBlockPos.north(distance as int) as Vec3i;
myMutableBlockPos.north(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

offset
offset(x as int, y as int, z as int) as BlockPos
script.zs
// MutableBlockPos.offset(x as int, y as int, z as int) as BlockPos;
myMutableBlockPos.offset(myInt, myInt, myInt);

Parameters:

x Type: int
y Type: int
z Type: int

Return Type: BlockPos

offset(other as Vec3i) as BlockPos
script.zs
// MutableBlockPos.offset(other as Vec3i) as BlockPos;
myMutableBlockPos.offset(myVec3i);

Parameters:

other Type: Vec3i

Return Type: BlockPos

offset(x as int, y as int, z as int) as Vec3i
script.zs
// MutableBlockPos.offset(x as int, y as int, z as int) as Vec3i;
myMutableBlockPos.offset(myInt, myInt, myInt);

Parameters:

x Type: int
y Type: int
z Type: int

Return Type: Vec3i

offset(other as Vec3i) as Vec3i
script.zs
// MutableBlockPos.offset(other as Vec3i) as Vec3i;
myMutableBlockPos.offset(myVec3i);

Parameters:

other Type: Vec3i

Return Type: Vec3i

relative
relative(direction as Direction) as BlockPos
script.zs
// MutableBlockPos.relative(direction as Direction) as BlockPos;
myMutableBlockPos.relative(myDirection);

Parameters:

direction Type: Direction

Return Type: BlockPos

relative(direction as Direction, distance as int) as BlockPos
script.zs
// MutableBlockPos.relative(direction as Direction, distance as int) as BlockPos;
myMutableBlockPos.relative(myDirection, myInt);

Parameters:

direction Type: Direction
distance Type: int

Return Type: BlockPos

relative(axis as Axis, distance as int) as BlockPos
script.zs
// MutableBlockPos.relative(axis as Axis, distance as int) as BlockPos;
myMutableBlockPos.relative(myAxis, myInt);

Parameters:

axis Type: Axis
distance Type: int

Return Type: BlockPos

relative(direction as Direction) as Vec3i
script.zs
// MutableBlockPos.relative(direction as Direction) as Vec3i;
myMutableBlockPos.relative(myDirection);

Parameters:

direction Type: Direction

Return Type: Vec3i

relative(direction as Direction, distance as int) as Vec3i
script.zs
// MutableBlockPos.relative(direction as Direction, distance as int) as Vec3i;
myMutableBlockPos.relative(myDirection, myInt);

Parameters:

direction Type: Direction
distance Type: int

Return Type: Vec3i

relative(axis as Axis, distanec as int) as Vec3i
script.zs
// MutableBlockPos.relative(axis as Axis, distanec as int) as Vec3i;
myMutableBlockPos.relative(myAxis, myInt);

Parameters:

axis Type: Axis
distanec Type: int

Return Type: Vec3i

rotate
rotate(rotation as Rotation) as BlockPos
script.zs
// MutableBlockPos.rotate(rotation as Rotation) as BlockPos;
myMutableBlockPos.rotate(myRotation);

Parameters:

rotation Type: Rotation

Return Type: BlockPos

setValue
setValue(x as int, y as int, z as int) as MutableBlockPos
script.zs
// MutableBlockPos.setValue(x as int, y as int, z as int) as MutableBlockPos;
myMutableBlockPos.setValue(myInt, myInt, myInt);

Parameters:

x Type: int
y Type: int
z Type: int

Return Type: MutableBlockPos

setValue(x as double, y as double, z as double) as MutableBlockPos
script.zs
// MutableBlockPos.setValue(x as double, y as double, z as double) as MutableBlockPos;
myMutableBlockPos.setValue(myDouble, myDouble, myDouble);

Parameters:

x Type: double
y Type: double
z Type: double

Return Type: MutableBlockPos

setValue(value as Vec3i) as MutableBlockPos
script.zs
// MutableBlockPos.setValue(value as Vec3i) as MutableBlockPos;
myMutableBlockPos.setValue(myVec3i);

Parameters:

value Type: Vec3i

Return Type: MutableBlockPos

setValue(value as long) as MutableBlockPos
script.zs
// MutableBlockPos.setValue(value as long) as MutableBlockPos;
myMutableBlockPos.setValue(myLong);

Parameters:

value Type: long

Return Type: MutableBlockPos

setValue(axisCycle as AxisCycle, x as int, y as int, z as int) as MutableBlockPos
script.zs
// MutableBlockPos.setValue(axisCycle as AxisCycle, x as int, y as int, z as int) as MutableBlockPos;
myMutableBlockPos.setValue(myAxisCycle, myInt, myInt, myInt);

Parameters:

axisCycle Type: AxisCycle
x Type: int
y Type: int
z Type: int

Return Type: MutableBlockPos

setWithOffset
setWithOffset(other as Vec3i, direction as Direction) as MutableBlockPos
script.zs
// MutableBlockPos.setWithOffset(other as Vec3i, direction as Direction) as MutableBlockPos;
myMutableBlockPos.setWithOffset(myVec3i, myDirection);

Parameters:

other Type: Vec3i
direction Type: Direction

Return Type: MutableBlockPos

setWithOffset(other as Vec3i, x as int, y as int, z as int) as MutableBlockPos
script.zs
// MutableBlockPos.setWithOffset(other as Vec3i, x as int, y as int, z as int) as MutableBlockPos;
myMutableBlockPos.setWithOffset(myVec3i, myInt, myInt, myInt);

Parameters:

other Type: Vec3i
x Type: int
y Type: int
z Type: int

Return Type: MutableBlockPos

setWithOffset(other as Vec3i, offset as Vec3i) as MutableBlockPos
script.zs
// MutableBlockPos.setWithOffset(other as Vec3i, offset as Vec3i) as MutableBlockPos;
myMutableBlockPos.setWithOffset(myVec3i, myVec3i);

Parameters:

other Type: Vec3i
offset Type: Vec3i

Return Type: MutableBlockPos

setX
setX(x as int) as MutableBlockPos
script.zs
// MutableBlockPos.setX(x as int) as MutableBlockPos;
myMutableBlockPos.setX(myInt);

Parameters:

x Type: int

Return Type: MutableBlockPos

setY
setY(y as int) as MutableBlockPos
script.zs
// MutableBlockPos.setY(y as int) as MutableBlockPos;
myMutableBlockPos.setY(myInt);

Parameters:

y Type: int

Return Type: MutableBlockPos

setZ
setZ(z as int) as MutableBlockPos
script.zs
// MutableBlockPos.setZ(z as int) as MutableBlockPos;
myMutableBlockPos.setZ(myInt);

Parameters:

z Type: int

Return Type: MutableBlockPos

south
south() as BlockPos
script.zs
// MutableBlockPos.south() as BlockPos;
myMutableBlockPos.south();

Return Type: BlockPos

south(distance as int) as BlockPos
script.zs
// MutableBlockPos.south(distance as int) as BlockPos;
myMutableBlockPos.south(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

south() as Vec3i
script.zs
// MutableBlockPos.south() as Vec3i;
myMutableBlockPos.south();

Return Type: Vec3i

south(distance as int) as Vec3i
script.zs
// MutableBlockPos.south(distance as int) as Vec3i;
myMutableBlockPos.south(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

subtract
subtract(other as Vec3i) as BlockPos
script.zs
// MutableBlockPos.subtract(other as Vec3i) as BlockPos;
myMutableBlockPos.subtract(myVec3i);

Parameters:

other Type: Vec3i

Return Type: BlockPos

subtract(other as Vec3i) as Vec3i
script.zs
// MutableBlockPos.subtract(other as Vec3i) as Vec3i;
myMutableBlockPos.subtract(myVec3i);

Parameters:

other Type: Vec3i

Return Type: Vec3i

toShortString
Getter
script.zs
// MutableBlockPos.toShortString as string
myMutableBlockPos.toShortString

Return Type: string

toShortString() as string
script.zs
// MutableBlockPos.toShortString() as string;
myMutableBlockPos.toShortString();

Return Type: string

west
west() as BlockPos
script.zs
// MutableBlockPos.west() as BlockPos;
myMutableBlockPos.west();

Return Type: BlockPos

west(distance as int) as BlockPos
script.zs
// MutableBlockPos.west(distance as int) as BlockPos;
myMutableBlockPos.west(myInt);

Parameters:

distance Type: int

Return Type: BlockPos

west() as Vec3i
script.zs
// MutableBlockPos.west() as Vec3i;
myMutableBlockPos.west();

Return Type: Vec3i

west(distance as int) as Vec3i
script.zs
// MutableBlockPos.west(distance as int) as Vec3i;
myMutableBlockPos.west(myInt);

Parameters:

distance Type: int

Return Type: Vec3i

x
Getter
script.zs
// MutableBlockPos.x as int
myMutableBlockPos.x

Return Type: int

x() as int
script.zs
// MutableBlockPos.x() as int;
myMutableBlockPos.x();

Return Type: int

y
Getter
script.zs
// MutableBlockPos.y as int
myMutableBlockPos.y

Return Type: int

y() as int
script.zs
// MutableBlockPos.y() as int;
myMutableBlockPos.y();

Return Type: int

z
Getter
script.zs
// MutableBlockPos.z as int
myMutableBlockPos.z

Return Type: int

z() as int
script.zs
// MutableBlockPos.z() as int;
myMutableBlockPos.z();

Return Type: int

Previous
Matrix3f OctahedralGroup
Next