Package org.bukkit.block.structure

Enum UsageMode

java.lang.Object
java.lang.Enum<UsageMode>
org.bukkit.block.structure.UsageMode
All Implemented Interfaces:
Serializable, Comparable<UsageMode>, java.lang.constant.Constable
public enum UsageMode extends Enum<UsageMode>
Represents how a Structure can be used.

  • Enum Constant Details

    • SAVE

      public static final UsageMode SAVE
      The mode used when saving a structure.

    • LOAD

      public static final UsageMode LOAD
      The mode used when loading a structure.

    • CORNER

      public static final UsageMode CORNER
      Used when saving a structure for easy size calculation. When using this mode, the Structure name MUST match the name in the second Structure block that is in SAVE.

    • DATA

      public static final UsageMode DATA
      Used to run specific custom functions, which can only be used for certain Structures. The structure block is removed after this function completes. The data tags (functions) can be found on the wiki.

  • Method Details

    • values

      public static UsageMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static UsageMode valueOf​(String name)
      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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null