Home Getting Started With Scripts Commands Examples
BracketDumpers BracketHandlers BracketValidators

Plane

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.

script.zs
import crafttweaker.api.util.direction.Plane;

Implemented Interfaces

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

Enum Constants

Plane is an enum. It has 2 enum constants. They are accessible using the code below.

script.zs
Plane.HORIZONTAL
Plane.VERTICAL

Methods

Return Type: Axis

script.zs
Plane.getRandomAxis(random as Random) as Axis
ParameterTypeDescription
Parameter
random
Type
Random
Description
No Description Provided

Return Type: Direction

script.zs
Plane.getRandomDirection(random as Random) as Direction
ParameterTypeDescription
Parameter
random
Type
Random
Description
No Description Provided

Return Type: stdlib.Iterator<Direction>

script.zs
// Plane.iterator() as stdlib.Iterator<Direction>
myPlane.iterator();

Return Type: boolean

script.zs
Plane.test(direction as Direction) as boolean
ParameterTypeDescription
Parameter
direction
Type
Direction
Description
No Description Provided

Properties

NameTypeHas GetterHas SetterDescription
Name
iterator
Type
stdlib.Iterator<Direction>
Has Getter
true
Has Setter
false
Description
No Description Provided