Interface OceanRuinStructure

All Superinterfaces:
DefinedStructure, Keyed, Registerable<OceanRuinStructure>, Structure, Wrapper
@NullMarked @AsOf("3.4.0") public interface OceanRuinStructure extends DefinedStructure, Registerable<OceanRuinStructure>
An ocean ruin.
Since:
3.4.0
See Also:

  • Method Details

    • biomeTemperature

      @AsOf("3.4.0") OceanRuinStructure.BiomeTemperature biomeTemperature()
      The template set the ruin is drawn from.
      Returns:
      the biome temperature
      Since:
      3.4.0

    • largeProbability

      @AsOf("3.4.0") float largeProbability()
      The chance, from 0 to 1, that the ruin is a large one.
      Returns:
      the large ruin probability
      Since:
      3.4.0

    • clusterProbability

      @AsOf("3.4.0") float clusterProbability()
      The chance, from 0 to 1, that a large ruin is surrounded by smaller ones.
      Returns:
      the cluster probability
      Since:
      3.4.0

    • withSettings

      @AsOf("3.4.0") default OceanRuinStructure withSettings(StructureSettings settings)
      Description copied from interface: DefinedStructure
      Returns a copy of this structure with the given settings.
      Specified by:
      withSettings in interface DefinedStructure
      Parameters:
      settings - the settings the copy carries
      Returns:
      a copy of this structure with the given settings

    • withResourceKey

      @AsOf("3.4.0") default OceanRuinStructure withResourceKey(ResourceKey resourceKey)
      Description copied from interface: DefinedStructure
      Returns a copy of this structure registered under the given key.
      Specified by:
      withResourceKey in interface DefinedStructure
      Parameters:
      resourceKey - the key the copy carries
      Returns:
      a copy of this structure with the given key

    • register

      @AsOf("3.4.0") OceanRuinStructure register()
      Description copied from interface: DefinedStructure
      Registers this structure under its resource key.
      Specified by:
      register in interface DefinedStructure
      Specified by:
      register in interface Registerable<OceanRuinStructure>
      Returns:
      this structure

    • toBuilder

      @AsOf("3.4.0") default OceanRuinStructure.Builder toBuilder()
      Converts this object back to a builder.
      Returns:
      a builder with the same values as this object
      Since:
      3.4.0

    • of

      @AsOf("3.4.0") static OceanRuinStructure of(@Nullable ResourceKey resourceKey, StructureSettings settings, OceanRuinStructure.BiomeTemperature biomeTemperature, float largeProbability, float clusterProbability)
      Creates a new ocean ruin.
      Parameters:
      resourceKey - the resource key of the structure, or null if not present
      settings - the settings every structure carries
      biomeTemperature - the template set the ruin is drawn from
      largeProbability - the chance, from 0 to 1, that the ruin is a large one
      clusterProbability - the chance, from 0 to 1, that a large ruin is surrounded by smaller ones
      Returns:
      a new ocean ruin
      Since:
      3.4.0

    • builder

      @AsOf("3.4.0") static OceanRuinStructure.Builder builder(StructureSettings settings, OceanRuinStructure.BiomeTemperature biomeTemperature)
      Creates a new builder with vanilla's probabilities: a 30% chance of a large ruin and a 90% chance of a cluster around it.
      Parameters:
      settings - the settings every structure carries
      biomeTemperature - the template set the ruin is drawn from
      Returns:
      a new builder
      Since:
      3.4.0