Package forestry.api.plugin

Interface IButterflySpeciesBuilder

All Superinterfaces:

ISpeciesBuilder<IButterflySpeciesType,IButterflySpecies,IButterflySpeciesBuilder>

public interface IButterflySpeciesBuilder
extends ISpeciesBuilder<IButterflySpeciesType,IButterflySpecies,IButterflySpeciesBuilder>

Builder used to register new butterfly and moth species and configure already existing ones. Use ILepidopterologyRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, java.awt.Color, float) to obtain instances of this class.

Nested Class Summary

Nested classes/interfaces inherited from interface forestry.api.plugin.ISpeciesBuilder

ISpeciesBuilder.ISpeciesFactory<T extends ISpeciesType<S,?>,S extends ISpecies<?>,B extends ISpeciesBuilder<T,S,B>>

Method Summary

Modifier and Type	Method	Description
List<IProduct>	buildCaterpillarProducts()
List<IProduct>	buildProducts()
float	getFlightDistance()
float	getRarity()
int	getSerumColor()
net.minecraft.tags.TagKey<net.minecraft.world.level.biome.Biome>	getSpawnBiomes()
boolean	isMoth()
boolean	isNocturnal()
IButterflySpeciesBuilder	setFlightDistance(float flightDistance)
IButterflySpeciesBuilder	setMoth(boolean moth)	Marks this butterfly species as a moth.
IButterflySpeciesBuilder	setNocturnal(boolean nocturnal)	Marks this butterfly as nocturnal, which makes the butterfly only spawn at night.
IButterflySpeciesBuilder	setRarity(float rarity)	Overrides the rarity set in ILepidopterologyRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, java.awt.Color, float).
default IButterflySpeciesBuilder	setSerumColor(Color color)	Deprecated, for removal: This API element is subject to removal in a future version. Use the variant that accepts a TextColor
IButterflySpeciesBuilder	setSerumColor(net.minecraft.network.chat.TextColor color)	Overrides the serum color set in ILepidopterologyRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, java.awt.Color, float).
IButterflySpeciesBuilder	setSpawnBiomes(net.minecraft.tags.TagKey<net.minecraft.world.level.biome.Biome> biomeTag)	Sets a tag limiting the biomes this butterfly can spawn in.

Methods inherited from interface forestry.api.plugin.ISpeciesBuilder

addMutations, buildGenome, buildMutations, createSpeciesFactory, getAuthority, getComplexity, getEscritoireColor, getGenus, getHumidity, getSpecies, getTemperature, hasGlint, isDominant, isSecret, setAuthority, setComplexity, setDominant, setEscritoireColor, setEscritoireColor, setFactory, setGenome, setGlint, setHumidity, setSecret, setTemperature

Method Details

setSerumColor

@Deprecated(forRemoval=true)
default IButterflySpeciesBuilder setSerumColor(Color color)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the variant that accepts a TextColor

setSerumColor

IButterflySpeciesBuilder setSerumColor(net.minecraft.network.chat.TextColor color)

Overrides the serum color set in ILepidopterologyRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, java.awt.Color, float).

setFlightDistance

IButterflySpeciesBuilder setFlightDistance(float flightDistance)

setNocturnal

IButterflySpeciesBuilder setNocturnal(boolean nocturnal)

Marks this butterfly as nocturnal, which makes the butterfly only spawn at night. Most, but not all, nocturnal butterflies are actually moths, so set setMoth(boolean) if this species is actually a moth.

setMoth

IButterflySpeciesBuilder setMoth(boolean moth)

Marks this butterfly species as a moth. The species name will show as "... Moth" instead of "... Butterfly". Most, but not all, moths are nocturnal, so setNocturnal(boolean) should probably be set too.

setSpawnBiomes

IButterflySpeciesBuilder setSpawnBiomes(net.minecraft.tags.TagKey<net.minecraft.world.level.biome.Biome> biomeTag)

Sets a tag limiting the biomes this butterfly can spawn in. By default, butterflies can spawn in any biome, given the climate at the spawn position is correct.

Parameters:

biomeTag - A set of biomes to limit spawning of this butterfly to.

setRarity

IButterflySpeciesBuilder setRarity(float rarity)

Overrides the rarity set in ILepidopterologyRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, java.awt.Color, float).

getSerumColor

int getSerumColor()

getFlightDistance

float getFlightDistance()

isNocturnal

boolean isNocturnal()

isMoth

boolean isMoth()

getSpawnBiomes

@Nullable
net.minecraft.tags.TagKey<net.minecraft.world.level.biome.Biome> getSpawnBiomes()

getRarity

float getRarity()

buildProducts

List<IProduct> buildProducts()

buildCaterpillarProducts

List<IProduct> buildCaterpillarProducts()