forestry.api.arboriculture

Interface ITreeFactory

All Known Implementing Classes:

TreeFactory

public interface ITreeFactory

Method Summary

Modifier and Type	Method and Description
IAlleleTreeSpeciesBuilder	createSpecies(java.lang.String uid, java.lang.String unlocalizedName, java.lang.String authority, java.lang.String unlocalizedDescription, boolean dominant, IClassification branch, java.lang.String binomial, java.lang.String modID, ILeafSpriteProvider leafSpriteProvider, IGermlingModelProvider germlingModelProvider, IWoodProvider woodProvider, ITreeGenerator generator) Deprecated. since Forestry 5.6.0. use createSpecies(String, String, String, String, boolean, IClassification, String, String, ILeafSpriteProvider, IGermlingModelProvider, IWoodProvider, ITreeGenerator, ILeafProvider)
IAlleleTreeSpeciesBuilder	createSpecies(java.lang.String uid, java.lang.String unlocalizedName, java.lang.String authority, java.lang.String unlocalizedDescription, boolean dominant, IClassification branch, java.lang.String binomial, java.lang.String modID, ILeafSpriteProvider leafSpriteProvider, IGermlingModelProvider germlingModelProvider, IWoodProvider woodProvider, ITreeGenerator generator, ILeafProvider leafProvider) Creates a new tree species.
ILeafSpriteProvider	getLeafIconProvider(EnumLeafType enumLeafType, java.awt.Color color, java.awt.Color colorPollinated) Get one of the built-in Forestry leaf types.

Method Detail

createSpecies

IAlleleTreeSpeciesBuilder createSpecies(java.lang.String uid,
                                        java.lang.String unlocalizedName,
                                        java.lang.String authority,
                                        java.lang.String unlocalizedDescription,
                                        boolean dominant,
                                        IClassification branch,
                                        java.lang.String binomial,
                                        java.lang.String modID,
                                        ILeafSpriteProvider leafSpriteProvider,
                                        IGermlingModelProvider germlingModelProvider,
                                        IWoodProvider woodProvider,
                                        ITreeGenerator generator,
                                        @Nullable
                                        ILeafProvider leafProvider)

Creates a new tree species. Automatically registered with AlleleManager.alleleRegistry.registerAllele() See IAlleleTreeSpeciesBuilder and IAlleleSpeciesBuilder for adding additional properties to the returned species.

Parameters:

uid - Unique Identifier for this species

unlocalizedName - Unlocalized name for this species

authority - Authority for the binomial name, e.g. "Sengir" on species of base Forestry.

unlocalizedDescription - Unlocalized description for this species

dominant - Whether this species is genetically dominant (false means it is recessive)

branch - Classification of this species

binomial - Binomial name of the species sans genus. "humboldti" will have the bee species flavour name be "Apis humboldti". Feel free to use fun names or null.

modID - The modID from the mod of the species

leafSpriteProvider - The leaf sprite provider for this species

germlingModelProvider - The germling model provider for this species

woodProvider - The wood texture provider. It is used to get wood textures for the charcoal pile.

generator - The tree generator

leafProvider - The leaf provider

Returns:

a new tree species allele.

createSpecies

@Deprecated
IAlleleTreeSpeciesBuilder createSpecies(java.lang.String uid,
                                                    java.lang.String unlocalizedName,
                                                    java.lang.String authority,
                                                    java.lang.String unlocalizedDescription,
                                                    boolean dominant,
                                                    IClassification branch,
                                                    java.lang.String binomial,
                                                    java.lang.String modID,
                                                    ILeafSpriteProvider leafSpriteProvider,
                                                    IGermlingModelProvider germlingModelProvider,
                                                    IWoodProvider woodProvider,
                                                    ITreeGenerator generator)

Deprecated. since Forestry 5.6.0. use createSpecies(String, String, String, String, boolean, IClassification, String, String, ILeafSpriteProvider, IGermlingModelProvider, IWoodProvider, ITreeGenerator, ILeafProvider)

getLeafIconProvider

ILeafSpriteProvider getLeafIconProvider(EnumLeafType enumLeafType,
                                        java.awt.Color color,
                                        java.awt.Color colorPollinated)

Get one of the built-in Forestry leaf types. Default type is deciduous.