Vec3i - 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.Vec3i;

Implemented Interfaces

Vec3i implements the following interfaces. That means all methods defined in these interfaces are also available in Vec3i

Comparable<Vec3i>

Methods

above

Name: above

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.above() as Vec3i

myVec3i.above();

above

Name: above

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

below

Name: below

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.below() as Vec3i

myVec3i.below();

below

Name: below

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

closerThan

Name: closerThan

Return Type: boolean

ZenScript
 Copy
Vec3i.closerThan(other as Vec3i, maxDistance as double) as boolean

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided
Parameter maxDistance	Type double	Description No Description Provided

closerThan

Name: closerThan

Return Type: boolean

ZenScript
 Copy
Vec3i.closerThan(position as Position, maxDistance as double) as boolean

Parameter	Type	Description
Parameter position	Type Position	Description No Description Provided
Parameter maxDistance	Type double	Description No Description Provided

compareTo

Name: compareTo

Return Type: int

ZenScript
 Copy
Vec3i.compareTo(other as Vec3i) as int

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

cross

Name: cross

Return Type: Vec3i

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

distManhattan

Name: distManhattan

Return Type: int

ZenScript
 Copy
Vec3i.distManhattan(other as Vec3i) as int

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

distSqr

Name: distSqr

Return Type: double

ZenScript
 Copy
Vec3i.distSqr(other as Vec3i) as double

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

distSqr

Name: distSqr

Return Type: double

ZenScript
 Copy
Vec3i.distSqr(other as Vec3i, useCenter as boolean) as double

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided
Parameter useCenter	Type boolean	Description No Description Provided

distSqr

Name: distSqr

Return Type: double

ZenScript
 Copy
Vec3i.distSqr(position as Position, other as boolean) as double

Parameter	Type	Description
Parameter position	Type Position	Description No Description Provided
Parameter other	Type boolean	Description No Description Provided

distSqr

Name: distSqr

Return Type: double

ZenScript
 Copy
Vec3i.distSqr(x as double, y as double, z as double, useCenter as boolean) as double

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
Parameter useCenter	Type boolean	Description No Description Provided

east

Name: east

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.east() as Vec3i

myVec3i.east();

east

Name: east

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

getValue

Name: getValue

Return Type: int

ZenScript
 Copy
Vec3i.getValue(axis as Axis) as int

Parameter	Type	Description
Parameter axis	Type Axis	Description No Description Provided

getX

Name: getX

Return Type: int

ZenScript
 Copy
// Vec3i.getX() as int

myVec3i.getX();

getY

Name: getY

Return Type: int

ZenScript
 Copy
// Vec3i.getY() as int

myVec3i.getY();

getZ

Name: getZ

Return Type: int

ZenScript
 Copy
// Vec3i.getZ() as int

myVec3i.getZ();

multiply

Name: multiply

Return Type: Vec3i

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

Parameter	Type	Description
Parameter scalar	Type int	Description No Description Provided

north

Name: north

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.north() as Vec3i

myVec3i.north();

north

Name: north

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

offset

Name: offset

Return Type: Vec3i

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

offset

Name: offset

Return Type: Vec3i

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

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: Vec3i

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

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: Vec3i

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

Parameter	Type	Description
Parameter direction	Type Direction	Description No Description Provided

relative

Name: relative

Return Type: Vec3i

ZenScript
 Copy
Vec3i.relative(axis as Axis, distanec as int) as Vec3i

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

relative

Name: relative

Return Type: Vec3i

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

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

south

Name: south

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.south() as Vec3i

myVec3i.south();

south

Name: south

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

subtract

Name: subtract

Return Type: Vec3i

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

Parameter	Type	Description
Parameter other	Type Vec3i	Description No Description Provided

toShortString

Name: toShortString

Return Type: string

ZenScript
 Copy
// Vec3i.toShortString() as string

myVec3i.toShortString();

west

Name: west

Return Type: Vec3i

ZenScript
 Copy
// Vec3i.west() as Vec3i

myVec3i.west();

west

Name: west

Return Type: Vec3i

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

Parameter	Type	Description
Parameter distance	Type int	Description No Description Provided

Properties

Name	Type	Has Getter	Has Setter	Description
Name toShortString	Type string	Has Getter true	Has Setter false	Description No Description Provided
Name x	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name y	Type int	Has Getter true	Has Setter false	Description No Description Provided
Name z	Type int	Has Getter true	Has Setter false	Description No Description Provided