Package forestry.api.lepidopterology.genetics

Interface IButterflySpecies

All Superinterfaces:
IRegistryAlleleValue, ISpecies<IButterfly>
public interface IButterflySpecies extends ISpecies<IButterfly>

  • Method Details

    • getType

      IButterflySpeciesType getType()
      Specified by:
      getType in interface ISpecies<IButterfly>
      Returns:
      The type of species this is.

    • getTemperature

      TemperatureType getTemperature()
      Returns:
      The ideal temperature for this butterfly to spawn and fly around in.

    • getHumidity

      HumidityType getHumidity()
      Returns:
      The ideal humidity for this butterfly to spawn and fly around in.

    • getSpawnBiomes

      @Nullable net.minecraft.tags.TagKey<net.minecraft.world.level.biome.Biome> getSpawnBiomes()
      Allows butterflies to restrict random spawns beyond the restrictions set by temperature() and humidity(). None of the butterflies added by base Forestry have a biome restriction.
      Returns:
      Tag of biomes this butterfly is limited to spawning in, or null if this butterfly can spawn in any biome.

    • getRarity

      float getRarity()
      Returns:
      Float between 0 and 1 representing the rarity of the species, will affect spawn rate.

    • getFlightDistance

      float getFlightDistance()
      Returns:
      Float representing the distance below which this butterfly will take flight if it detects a player which is not sneaking.

    • isNocturnal

      boolean isNocturnal()
      Returns:
      true if this species is only active at night.

    • isMoth

      boolean isMoth()
      Returns:
      true if this species is a Moth species instead of a Butterfly

    • getButterflyLoot

      List<IProduct> getButterflyLoot()
      Returns:
      The loot that drops if you kill a butterfly.

    • getCaterpillarProducts

      List<IProduct> getCaterpillarProducts()
      Returns:
      The loot that drops if you destroy a leaf that contains a caterpillar.

    • getSerumColor

      int getSerumColor()
      Returns:
      The color of this butterfly's serum item. Also used for escritoire cells.

    • getEscritoireColor

      default int getEscritoireColor()
      Specified by:
      getEscritoireColor in interface ISpecies<IButterfly>
      Returns:
      The color of cells that contain this species in the Escritoire research game