forestry.api.apiculture

Interface IBeeFactory

All Known Implementing Classes:

BeeFactory

public interface IBeeFactory

Method Summary

Modifier and Type	Method and Description
IClassification	createBranch(java.lang.String uid, java.lang.String scientific) Creates a new bee branch.
IAlleleBeeSpeciesBuilder	createSpecies(java.lang.String uid, boolean dominant, java.lang.String authority, java.lang.String unlocalizedName, java.lang.String unlocalizedDescription, IClassification branch, java.lang.String binomial, int primaryColor, int secondaryColor) Deprecated. since Forestry 5.6.0. use createSpecies(String, String, boolean, String, String, String, IClassification, String, int, int)
IAlleleBeeSpeciesBuilder	createSpecies(java.lang.String modId, java.lang.String uid, boolean dominant, java.lang.String authority, java.lang.String unlocalizedName, java.lang.String unlocalizedDescription, IClassification branch, java.lang.String binomial, int primaryColor, int secondaryColor) Creates a new bee species.

Method Detail

createSpecies

IAlleleBeeSpeciesBuilder createSpecies(java.lang.String modId,
                                       java.lang.String uid,
                                       boolean dominant,
                                       java.lang.String authority,
                                       java.lang.String unlocalizedName,
                                       java.lang.String unlocalizedDescription,
                                       IClassification branch,
                                       java.lang.String binomial,
                                       int primaryColor,
                                       int secondaryColor)

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

Parameters:

modId - The modId of the mod that is creating the species

uid - Unique Identifier for this species

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

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

unlocalizedName - Unlocalized name for this species

unlocalizedDescription - Unlocalized description for this species

branch - Classification of this species

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

primaryColor - The outline color of this species

secondaryColor - The body color of this species

Returns:

a new bee species allele.

Since:

Forestry 5.6.0.

createBranch

IClassification createBranch(java.lang.String uid,
                             java.lang.String scientific)

Creates a new bee branch. Must be registered with AlleleManager.alleleRegistry.getClassification("family.apidae").addMemberGroup();

Parameters:

uid - Unique Identifier for this branch

scientific - approximates a "genus" in real life. Real life examples: "Micrapis", "Megapis"

Returns:

a new bee branch

createSpecies

@Deprecated
IAlleleBeeSpeciesBuilder createSpecies(java.lang.String uid,
                                                   boolean dominant,
                                                   java.lang.String authority,
                                                   java.lang.String unlocalizedName,
                                                   java.lang.String unlocalizedDescription,
                                                   IClassification branch,
                                                   java.lang.String binomial,
                                                   int primaryColor,
                                                   int secondaryColor)

Deprecated. since Forestry 5.6.0. use createSpecies(String, String, boolean, String, String, String, IClassification, String, int, int)