forestry.api.genetics

Interface ISpeciesRoot

All Known Subinterfaces:

IBeeRoot, IButterflyRoot, ISpeciesRootPollinatable, ITreeRoot

All Known Implementing Classes:

BeeRoot, ButterflyRoot, SpeciesRoot, TreeRoot

public interface ISpeciesRoot

Describes a class of species (i.e. bees, trees, butterflies), provides helper functions and access to common functionality.

Method Summary

Modifier and Type	Method and Description
IAlyzerPlugin	getAlyzerPlugin() Plugin to add information for the handheld genetic analyzer.
IBreedingTracker	getBreedingTracker(net.minecraft.world.World world, com.mojang.authlib.GameProfile player)
java.util.List<? extends IMutation>	getCombinations(IAllele other)
java.util.List<IMutation>	getCombinations(IAlleleSpecies parentSpecies0, IAlleleSpecies parentSpecies1, boolean shuffle)
IAllele[]	getDefaultTemplate()
java.util.Map<java.lang.String,IAllele[]>	getGenomeTemplates()
ISpeciesType	getIconType() Species type used to represent this species in icons
java.util.List<? extends IIndividual>	getIndividualTemplates()
IChromosomeType[]	getKaryotype()
IIndividual	getMember(net.minecraft.item.ItemStack stack)
IIndividual	getMember(net.minecraft.nbt.NBTTagCompound compound)
java.lang.Class<? extends IIndividual>	getMemberClass()
default net.minecraft.item.ItemStack	getMemberStack(IAllele[] template, ISpeciesType type)
default net.minecraft.item.ItemStack	getMemberStack(IAlleleSpecies species, ISpeciesType type)
net.minecraft.item.ItemStack	getMemberStack(IIndividual individual, ISpeciesType type)
java.util.List<? extends IMutation>	getMutations(boolean shuffle)
java.util.Collection<? extends IMutation>	getPaths(IAllele result, IChromosomeType chromosomeType)
IAllele[]	getRandomTemplate(java.util.Random rand)
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getResearchCatalysts()
java.util.List<? extends IMutation>	getResultantMutations(IAllele other)
IChromosomeType	getSpeciesChromosomeType()
int	getSpeciesCount()
default IDatabasePlugin	getSpeciesPlugin() Plugin to add information for the handheld genetic analyzer and the database.
IAllele[]	getTemplate(IAlleleSpecies species) Retrieves a registered template using the passed species.
IAllele[]	getTemplate(java.lang.String identifier) Retrieves a registered template using the passed species unique identifier.
<O,I extends IIndividual> IIndividualTranslator<I,O>	getTranslator(java.lang.Object translatorKey)
ISpeciesType	getType(net.minecraft.item.ItemStack itemStack)
default ISpeciesType	getTypeForMutation(int position) The type of the species that will be used at the given position of the mutation recipe in the gui.
default ISpeciesType[]	getTypes()
java.lang.String	getUID()
boolean	isMember(IIndividual individual) Used to check whether the given IIndividual is member of this class.
boolean	isMember(net.minecraft.item.ItemStack stack) Used to check whether a given itemstack contains genetic data corresponding to an IIndividual of this class.
boolean	isMember(net.minecraft.item.ItemStack stack, ISpeciesType type) Used to check whether a given itemstack contains genetic data corresponding to an IIndividual of this class and matches the given type.
void	registerMutation(IMutation mutation) Use to register mutations.
void	registerTemplate(IAllele[] template) Registers a bee template using the UID of the first allele as identifier.
void	registerTemplate(java.lang.String identifier, IAllele[] template) Registers a bee template using the passed identifier.
<O,I extends IIndividual> void	registerTranslator(java.lang.Object translatorKey, IIndividualTranslator<I,O> translator)
void	setResearchSuitability(net.minecraft.item.ItemStack itemstack, float suitability) Sets an item stack as a valid (generic) research catalyst for this class.
IChromosome[]	templateAsChromosomes(IAllele[] template)
IChromosome[]	templateAsChromosomes(IAllele[] templateActive, IAllele[] templateInactive)
IGenome	templateAsGenome(IAllele[] template)
IGenome	templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive)
IIndividual	templateAsIndividual(IAllele[] template)
IIndividual	templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive)
<O,I extends IIndividual> I	translateMember(O objectToTranslator)

Method Detail

getUID

java.lang.String getUID()

Returns:

A unique identifier for the species class. Should consist of "root" + a common name for the species class in camel-case, i.e. "rootBees", "rootTrees", "rootButterflies".

getMemberClass

java.lang.Class<? extends IIndividual> getMemberClass()

Returns:

Class of the sub-interface inheriting from IIndividual.

getSpeciesCount

int getSpeciesCount()

Returns:

Integer denoting the number of (counted) species of this type in the world.

isMember

boolean isMember(net.minecraft.item.ItemStack stack)

Used to check whether a given itemstack contains genetic data corresponding to an IIndividual of this class.

Parameters:

stack - itemstack to check.

Returns:

true if the itemstack contains an IIndividual of this class, false otherwise.

isMember

boolean isMember(net.minecraft.item.ItemStack stack,
                 ISpeciesType type)

Used to check whether a given itemstack contains genetic data corresponding to an IIndividual of this class and matches the given type.

Parameters:

stack - itemstack to check.

type - Integer denoting the type needed to match. (i.e. butterfly vs. butterfly serum; bee queens, princesses, drones; etc.)

Returns:

true if the itemstack contains an IIndividual of this class, false otherwise.

isMember

boolean isMember(IIndividual individual)

Used to check whether the given IIndividual is member of this class.

Parameters:

individual - IIndividual to check.

Returns:

true if the individual is member of this class, false otherwise.

getMember

@Nullable
IIndividual getMember(net.minecraft.item.ItemStack stack)

getMember

IIndividual getMember(net.minecraft.nbt.NBTTagCompound compound)

registerTranslator

<O,I extends IIndividual> void registerTranslator(java.lang.Object translatorKey,
                                                  IIndividualTranslator<I,O> translator)

getTranslator

@Nullable
<O,I extends IIndividual> IIndividualTranslator<I,O> getTranslator(java.lang.Object translatorKey)

translateMember

@Nullable
<O,I extends IIndividual> I translateMember(O objectToTranslator)

getType

@Nullable
ISpeciesType getType(net.minecraft.item.ItemStack itemStack)

getIconType

ISpeciesType getIconType()

Species type used to represent this species in icons

getTypes

default ISpeciesType[] getTypes()

getMemberStack

net.minecraft.item.ItemStack getMemberStack(IIndividual individual,
                                            ISpeciesType type)

getMemberStack

default net.minecraft.item.ItemStack getMemberStack(IAlleleSpecies species,
                                                    ISpeciesType type)

getMemberStack

default net.minecraft.item.ItemStack getMemberStack(IAllele[] template,
                                                    ISpeciesType type)

getBreedingTracker

IBreedingTracker getBreedingTracker(net.minecraft.world.World world,
                                    @Nullable
                                    com.mojang.authlib.GameProfile player)

templateAsIndividual

IIndividual templateAsIndividual(IAllele[] template)

templateAsIndividual

IIndividual templateAsIndividual(IAllele[] templateActive,
                                 IAllele[] templateInactive)

templateAsChromosomes

IChromosome[] templateAsChromosomes(IAllele[] template)

templateAsChromosomes

IChromosome[] templateAsChromosomes(IAllele[] templateActive,
                                    IAllele[] templateInactive)

templateAsGenome

IGenome templateAsGenome(IAllele[] template)

templateAsGenome

IGenome templateAsGenome(IAllele[] templateActive,
                         IAllele[] templateInactive)

registerTemplate

void registerTemplate(IAllele[] template)

Registers a bee template using the UID of the first allele as identifier.

registerTemplate

void registerTemplate(java.lang.String identifier,
                      IAllele[] template)

Registers a bee template using the passed identifier.

getTemplate

@Nullable
IAllele[] getTemplate(java.lang.String identifier)

Retrieves a registered template using the passed species unique identifier.

Parameters:

identifier - species UID

Returns:

Array of IAllele representing a genome.

getTemplate

IAllele[] getTemplate(IAlleleSpecies species)

Retrieves a registered template using the passed species.

Parameters:

species - species

Returns:

Array of IAllele representing a genome.

getDefaultTemplate

IAllele[] getDefaultTemplate()

Returns:

Default individual template for use when stuff breaks.

getRandomTemplate

IAllele[] getRandomTemplate(java.util.Random rand)

Parameters:

rand - Random to use.

Returns:

A random template from the pool of registered species templates.

getGenomeTemplates

java.util.Map<java.lang.String,IAllele[]> getGenomeTemplates()

getIndividualTemplates

java.util.List<? extends IIndividual> getIndividualTemplates()

getTypeForMutation

default ISpeciesType getTypeForMutation(int position)

The type of the species that will be used at the given position of the mutation recipe in the gui.

Parameters:

position - 0 = first parent, 1 = second parent, 2 = result

registerMutation

void registerMutation(IMutation mutation)

Use to register mutations.

getMutations

java.util.List<? extends IMutation> getMutations(boolean shuffle)

Returns:

All registered mutations.

getCombinations

java.util.List<? extends IMutation> getCombinations(IAllele other)

Parameters:

other - Allele to match mutations against.

Returns:

All registered mutations the given allele is part of.

getResultantMutations

java.util.List<? extends IMutation> getResultantMutations(IAllele other)

Parameters:

other - Allele to match mutations against.

Returns:

All registered mutations the give allele is resolute of.

getCombinations

java.util.List<IMutation> getCombinations(IAlleleSpecies parentSpecies0,
                                          IAlleleSpecies parentSpecies1,
                                          boolean shuffle)

Returns:

all possible mutations that result from breeding two species

Since:

Forestry 3.7

getPaths

java.util.Collection<? extends IMutation> getPaths(IAllele result,
                                                   IChromosomeType chromosomeType)

getResearchCatalysts

java.util.Map<net.minecraft.item.ItemStack,java.lang.Float> getResearchCatalysts()

Returns:

List of generic catalysts which should be accepted for research by species of this class.

setResearchSuitability

void setResearchSuitability(net.minecraft.item.ItemStack itemstack,
                            float suitability)

Sets an item stack as a valid (generic) research catalyst for this class.

Parameters:

itemstack - ItemStack to set as suitable.

suitability - Float between 0 and 1 to indicate suitability.

getKaryotype

IChromosomeType[] getKaryotype()

Returns:

Array of all IChromosomeType which are in this species genome

getSpeciesChromosomeType

IChromosomeType getSpeciesChromosomeType()

Returns:

IChromosomeType which is the "key" for this species class, the species chromosome.

getAlyzerPlugin

IAlyzerPlugin getAlyzerPlugin()

Plugin to add information for the handheld genetic analyzer.

getSpeciesPlugin

@Nullable
default IDatabasePlugin getSpeciesPlugin()

Plugin to add information for the handheld genetic analyzer and the database.

Since:

5.7