api/org.kryptonmc.api.block.meta/StructureMode

StructureMode

enum StructureMode : Enum<StructureMode> , Translatable

Indicates the mode that a structure block this property is applied to is in.

The mode of a structure block influences its behaviour. For example, in load mode, the structure block will load a saved structure. In save mode, it will save a captured structure.

Entries

LOAD

In this mode, a structure block can load a saved structure in to the world.

SAVE

In this mode, a structure block can save a captured structure for use later.

CORNER

In this mode, a structure block will act as a marker for the opposing corner of a structure block in save mode.

DATA

In this mode, a structure block will mark the location of a function to run, specified by its metadata input. This only works for specific structures, and only during natural generation.

Functions

translationKey

open override fun translationKey(): String

valueOf

fun valueOf(value: String): StructureMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<StructureMode>

Returns an array containing the constants of this enum type, in the order they're declared.

Properties

name

val name: String

ordinal

val ordinal: Int