Package forestry.api.plugin

Interface ITreeSpeciesBuilder

All Superinterfaces:

ISpeciesBuilder<ITreeSpeciesType,ITreeSpecies,ITreeSpeciesBuilder>

public interface ITreeSpeciesBuilder
extends ISpeciesBuilder<ITreeSpeciesType,ITreeSpecies,ITreeSpeciesBuilder>

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
ITreeSpeciesBuilder	addVanillaSapling(net.minecraft.world.item.Item sapling)	Adds a mundane item (no genetic component/NBT) that Forestry should consider as members of this species.
ITreeSpeciesBuilder	addVanillaStates(Collection<net.minecraft.world.level.block.state.BlockState> states)	Adds mundane states (no genetic BE) that Forestry should consider as members of this species.
net.minecraft.world.item.ItemStack	getDecorativeLeaves()
ITreeGenerator	getGenerator()
float	getRarity()
List<net.minecraft.world.level.block.state.BlockState>	getVanillaLeafStates()
List<net.minecraft.world.item.Item>	getVanillaSaplingItems()
ITreeSpeciesBuilder	setDecorativeLeaves(net.minecraft.world.item.ItemStack stack)	Sets the decorative leaves block for this tree species.
ITreeSpeciesBuilder	setEscritoireColor(net.minecraft.network.chat.TextColor color)	Overrides the escritoire color set in IArboricultureRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, net.minecraft.network.chat.TextColor, forestry.api.arboriculture.IWoodType).
ITreeSpeciesBuilder	setGenerator(ITreeGenerator generator)	Sets the tree generator instance used to generate trees when growing from a sapling or being placed in the world.
ITreeSpeciesBuilder	setRarity(float rarity)	Sets the rarity for this tree to generate in a chunk during world generation.
ITreeSpeciesBuilder	setTreeFeature(Function<ITreeGenData,net.minecraft.world.level.levelgen.feature.Feature<net.minecraft.world.level.levelgen.feature.configurations.NoneFeatureConfiguration>> factory)	Shortcut to create a tree generator using the tree generator built into Forestry.
ITreeSpeciesBuilder	setWoodType(IWoodType woodType)	Overrides the wood type set in IArboricultureRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, net.minecraft.network.chat.TextColor, forestry.api.arboriculture.IWoodType).

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, setFactory, setGenome, setGlint, setHumidity, setSecret, setTemperature

Method Details

setTreeFeature

ITreeSpeciesBuilder setTreeFeature(Function<ITreeGenData,net.minecraft.world.level.levelgen.feature.Feature<net.minecraft.world.level.levelgen.feature.configurations.NoneFeatureConfiguration>> factory)

Shortcut to create a tree generator using the tree generator built into Forestry.

setGenerator

ITreeSpeciesBuilder setGenerator(ITreeGenerator generator)

Sets the tree generator instance used to generate trees when growing from a sapling or being placed in the world.

Parameters:

generator - The tree generator instance. Use setTreeFeature(java.util.function.Function<forestry.api.arboriculture.ITreeGenData, net.minecraft.world.level.levelgen.feature.Feature<net.minecraft.world.level.levelgen.feature.configurations.NoneFeatureConfiguration>>) to use Forestry's default generator.

addVanillaStates

ITreeSpeciesBuilder addVanillaStates(Collection<net.minecraft.world.level.block.state.BlockState> states)

Adds mundane states (no genetic BE) that Forestry should consider as members of this species. When Forestry encounters a mundane leaf/sapling block, a list of states are queried to see what individual the block should contain. The genome of this individual always has the DEFAULT genome.

An example where this is used is to treat vanilla Oak leaves and saplings as members of the Apple Oak species. There is another important case: treating "decorative" and "default" leaves as members of a species. Forestry adds default and decorative forms of all leaf blocks to avoid generating trees with tons of BEs. These forms lack BEs, so these block states are passed to this method as well.

Parameters:

states - A list of mundane (no BE) states to add as members of this species.

addVanillaSapling

ITreeSpeciesBuilder addVanillaSapling(net.minecraft.world.item.Item sapling)

Adds a mundane item (no genetic component/NBT) that Forestry should consider as members of this species. Used by the portable analyzer to convert vanilla saplings into their Forestry equivalents when analyzing.

Parameters:

sapling - The item that should count as this species.

setDecorativeLeaves

ITreeSpeciesBuilder setDecorativeLeaves(net.minecraft.world.item.ItemStack stack)

Sets the decorative leaves block for this tree species. Used by shears and pick-block. The decorative form has no genome or block entity which is better for performance, but has no functionality. Calling this method is not required but highly recommended.

Parameters:

stack - The item form of the decorative leaves for this species.

Returns:

The decorative form of this species's leaves block.

setWoodType

ITreeSpeciesBuilder setWoodType(IWoodType woodType)

Overrides the wood type set in IArboricultureRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, net.minecraft.network.chat.TextColor, forestry.api.arboriculture.IWoodType).

setRarity

ITreeSpeciesBuilder setRarity(float rarity)

Sets the rarity for this tree to generate in a chunk during world generation. By default, the rarity is 0, which means the tree never spawns naturally.

Parameters:

rarity - A float between 0 and 1 that determines how often this tree spawns naturally.

setEscritoireColor

ITreeSpeciesBuilder setEscritoireColor(net.minecraft.network.chat.TextColor color)

Overrides the escritoire color set in IArboricultureRegistration.registerSpecies(net.minecraft.resources.ResourceLocation, java.lang.String, java.lang.String, boolean, net.minecraft.network.chat.TextColor, forestry.api.arboriculture.IWoodType).

Specified by:

setEscritoireColor in interface ISpeciesBuilder<ITreeSpeciesType,ITreeSpecies,ITreeSpeciesBuilder>

Parameters:

color - The color.

See Also:

• ISpeciesBuilder.setEscritoireColor(net.minecraft.network.chat.TextColor)

getGenerator

@Nullable
ITreeGenerator getGenerator()

getVanillaLeafStates

List<net.minecraft.world.level.block.state.BlockState> getVanillaLeafStates()

getVanillaSaplingItems

List<net.minecraft.world.item.Item> getVanillaSaplingItems()

getDecorativeLeaves

net.minecraft.world.item.ItemStack getDecorativeLeaves()

getRarity

float getRarity()