Represents a direction axis (X, Y, Z)

Importing the class

Link to 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.DirectionAxis;

Extending Enum<DirectionAxis>

Link to extending-enumdirectionaxis

DirectionAxis extends Enum<DirectionAxis>. That means all methods available in Enum<DirectionAxis> are also available in DirectionAxis

Implemented Interfaces

Link to implemented-interfaces

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

  • Predicate

Static Properties

Link to static-properties

NameTypeHas GetterHas SetterDescription
Name
X
Type
DirectionAxis
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
Y
Type
DirectionAxis
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
Z
Type
DirectionAxis
Has Getter
true
Has Setter
false
Description
No Description Provided

Name: equals

Return Type: boolean

ZenScript
Copy
DirectionAxis.equals(o as Object) as boolean
ParameterTypeDescription
Parameter
o
Type
Object
Description
No Description Provided

Name: getCoordinate

Gets the coordinate of this axis based on the given values, if this axis is "X", then it will return the value of the "x" parameter

Returns: value of the coordinate
Return Type: double

ZenScript
Copy
// DirectionAxis.getCoordinate(x as double, y as double, z as double) as double

<directionaxis:x>.getCoordinate(1.2, 2.5, 3.87);
ParameterTypeDescription
Parameter
x
Type
double
Description
x value of the coordinate
Parameter
y
Type
double
Description
y value of the coordinate
Parameter
z
Type
double
Description
z value of the coordinate

Name: getCoordinate

Gets the coordinate of this axis based on the given values, if this axis is "X", then it will return the value of the "x" parameter

Returns: value of the coordinate
Return Type: int

ZenScript
Copy
// DirectionAxis.getCoordinate(x as int, y as int, z as int) as int

<directionaxis:x>.getCoordinate(1, 2, 3);
ParameterTypeDescription
Parameter
x
Type
int
Description
x value of the coordinate
Parameter
y
Type
int
Description
y value of the coordinate
Parameter
z
Type
int
Description
z value of the coordinate

Name: hashCode

Return Type: int

ZenScript
Copy
// DirectionAxis.hashCode() as int

<directionaxis:x>.hashCode();
NameTypeHas GetterHas SetterDescription
Name
commandString
Type
string
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
hashCode
Type
int
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
horizontal
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
name
Type
string
Has Getter
true
Has Setter
false
Description
Get the name of this Axis ("X", "Y" or "Z")
Name
ordinal
Type
int
Has Getter
true
Has Setter
false
Description
Gets the enum ordinal of this axis
Name
vertical
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided