Axis - CraftTweaker Documentation

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.

import crafttweaker.api.util.direction.Axis;

Implements

Axis implements the following interfaces:

StringRepresentable

Undocumented Interfaces

Predicate<Direction>,Comparable<Enum>

Enum Constants

Axis is an enum with 3 constants. They are accessible like so:

// Axis.X
<constant:minecraft:direction/axis:x>
// Axis.Y
<constant:minecraft:direction/axis:y>
// Axis.Z
<constant:minecraft:direction/axis:z>

Members

// Axis.choose(x as int, y as int, z as int) as int;
<constant:minecraft:direction/axis:x>.choose(myInt, myInt, myInt);

Parameters:

x: int Type: int

y: int Type: int

z: int Type: int

Return Type: int

// Axis.choose(x as double, y as double, z as double) as double;
<constant:minecraft:direction/axis:x>.choose(myDouble, myDouble, myDouble);

Parameters:

x: double Type: double

y: double Type: double

z: double Type: double

Return Type: double

// Axis.horizontal as bool
<constant:minecraft:direction/axis:x>.horizontal

Return Type: bool

// Axis.horizontal() as bool;
<constant:minecraft:direction/axis:x>.horizontal();

Return Type: bool

// Axis.name as string
<constant:minecraft:direction/axis:x>.name

Return Type: string

// Axis.name() as string;
<constant:minecraft:direction/axis:x>.name();

Return Type: string

// Axis.plane as Plane
<constant:minecraft:direction/axis:x>.plane

Return Type: Plane

// Axis.plane() as Plane;
<constant:minecraft:direction/axis:x>.plane();

Return Type: Plane

Gets the serialized name.

// Axis.serializedName as string
<constant:minecraft:direction/axis:x>.serializedName

Return Type: string

Gets the serialized name.

Returns: the serialized name.

// Axis.serializedName() as string;
<constant:minecraft:direction/axis:x>.serializedName();

Return Type: string

// Axis.test(direction as Direction) as bool;
<constant:minecraft:direction/axis:x>.test(myDirection);

Parameters:

direction: Direction Type: Direction

Return Type: bool

// Axis.vertical as bool
<constant:minecraft:direction/axis:x>.vertical

Return Type: bool

// Axis.vertical() as bool;
<constant:minecraft:direction/axis:x>.vertical();

Return Type: bool