Enum Class IStructureElement.PlaceResult

java.lang.Object
java.lang.Enum<IStructureElement.PlaceResult>
com.gtnewhorizon.structurelib.structure.IStructureElement.PlaceResult
All Implemented Interfaces:
Serializable, Comparable<IStructureElement.PlaceResult>, Constable
Enclosing interface:
IStructureElement<T>

public static enum IStructureElement.PlaceResult extends Enum<IStructureElement.PlaceResult>
  • Enum Constant Details

    • SKIP

      public static final IStructureElement.PlaceResult SKIP
      This element either exists already, or does not yet have an implementation for survivalPlaceBlock, or some other unforeseen situations. TODO this definition doesn't seem right. Should we separate SKIP from EXISTS, or SKIP from ERROR?
    • REJECT

      public static final IStructureElement.PlaceResult REJECT
      This element's space is occupied by other stuff and require player attention, or player missing required resource, or the block cannot be placed due to obscure mechanisms, or some other unforeseen situations.
    • STOP

      public static final IStructureElement.PlaceResult STOP
      Autoplace cannot proceed within this tick. To proceed further would require stopping the placement and wait for next round.
    • ACCEPT

      public static final IStructureElement.PlaceResult ACCEPT
      Element placed successfully.
    • ACCEPT_STOP

      public static final IStructureElement.PlaceResult ACCEPT_STOP
      Combination of ACCEPT and STOP.

      Element placed successfully. To proceed further would require stopping the placement and wait for next round.

  • Method Details

    • values

      public static IStructureElement.PlaceResult[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static IStructureElement.PlaceResult valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null