Package me.gamercoder215.starcosmetics.api.cosmetics.structure

Class StructureInfo

java.lang.Object
me.gamercoder215.starcosmetics.api.cosmetics.structure.StructureInfo
public final class StructureInfo extends Object
Represents an Information Holder for a Structure

  • Method Details

    • getPoints

      @NotNull public @NotNull Map<StructurePoint,Material> getPoints()
      Fetches a Map of StructurePoints to Materials that the Structure will place.
      Returns:
      StructurePoint to Material Blueprint Map

    • getStructure

      @NotNull public @NotNull Structure getStructure()
      Fetches the Structure this information uses.
      Returns:
      Structure

    • getUniqueId

      @NotNull public @NotNull UUID getUniqueId()
      Fetches the unique identifier of the Structure.
      Returns:
      Structure Key

    • getRarity

      @NotNull public @NotNull Rarity getRarity()
      Fetches the Structure's Rarity.
      Returns:
      Structure Rarity

    • getLocalizedName

      @NotNull public @NotNull String getLocalizedName()
      Fetches the Localized Name of the Structure.
      Returns:
      Localized Name

    • getMinVersion

      @NotNull public @NotNull String getMinVersion()
      Fetches the minimum version of Minecraft that this Structure is compatible with.
      Returns:
      Minimum Minecraft Version

    • isCompatible

      @Deprecated public boolean isCompatible()
      Deprecated.
      Structures will not be read properly and will throw errors if they are read on an incompatible version, making this method obselete.
      Whether this Structure is compatible with this version of Minecraft.
      Returns:
      true if this Structure is compatible with this version of Minecraft, false otherwise.

    • getCriteria

      @NotNull public @NotNull CompletionCriteria getCriteria()
      Fetches the Completion Criteria for this Structure.
      Returns:
      Completion Criteria

    • getPrimaryMaterial

      @NotNull public @NotNull Material getPrimaryMaterial()
      Fetches the Primary Material used in this Structure.
      Returns:
      Primary Material

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object