Home Getting Started With Scripts Commands Examples

Direction

Represents a cardinal direction (north, south, east, west) and (up and down).

This class was added by a mod with mod-id crafttweaker. So you need to have this mod installed if you want to use this feature.

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.

script.zs
crafttweaker.api.util.Direction

Methods

rotateAround

Rotates this direction around a given Axis

Returns crafttweaker.api.util.Direction

script.zs
<direction:north>.rotateAround(axis as crafttweaker.api.util.DirectionAxis);
<direction:north>.rotateAround(<directionaxis:north>);
ParameterTypeDescription
Parameter
axis
Type
crafttweaker.api.util.DirectionAxis
Description
the Axis to rotate around

rotateY

Rotates this direction on the Y axis

Returns: the direction that rotated on the Y axis of this direction

Returns crafttweaker.api.util.Direction

script.zs
<direction:north>.rotateY();

rotateYCCW

Rotates this direction counter-clock wise on the Y axis

Returns: the direction that is counter clockwise on the Y axis

Returns crafttweaker.api.util.Direction

script.zs
<direction:north>.rotateYCCW();

Properties

NameTypeHas GetterHas Setter
Name
axis
Type
crafttweaker.api.util.DirectionAxis
Has Getter
true
Has Setter
false
Name
axisOffset
Type
int
Has Getter
true
Has Setter
false
Name
horizontalAngle
Type
float
Has Getter
true
Has Setter
false
Name
horizontalIndex
Type
int
Has Getter
true
Has Setter
false
Name
index
Type
int
Has Getter
true
Has Setter
false
Name
name
Type
String
Has Getter
true
Has Setter
false
Name
opposite
Type
crafttweaker.api.util.Direction
Has Getter
true
Has Setter
false
Name
xOffset
Type
int
Has Getter
true
Has Setter
false
Name
yOffset
Type
int
Has Getter
true
Has Setter
false
Name
zOffset
Type
int
Has Getter
true
Has Setter
false