forestry.arboriculture.genetics

Class TreeRoot

java.lang.Object

forestry.core.genetics.SpeciesRoot

forestry.arboriculture.genetics.TreeRoot

All Implemented Interfaces:

ITreeRoot, ISpeciesRoot, ISpeciesRootPollinatable

public class TreeRoot
extends SpeciesRoot
implements ITreeRoot

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<ITree>	treeTemplates
static java.lang.String	UID

Fields inherited from class forestry.core.genetics.SpeciesRoot

speciesTemplates

Constructor Summary

Constructors

Constructor and Description
TreeRoot()

Method Summary

Modifier and Type	Method and Description
ICheckPollinatable	createPollinatable(IIndividual individual)
IAlyzerPlugin	getAlyzerPlugin() Plugin to add information for the handheld genetic analyzer.
IArboristTracker	getBreedingTracker(net.minecraft.world.World world, com.mojang.authlib.GameProfile player)
IAllele[]	getDefaultTemplate()
java.util.Collection<IFruitProvider>	getFruitProvidersForFruitFamily(IFruitFamily fruitFamily)
EnumGermlingType	getIconType() Species type used to represent this species in icons
java.util.List<ITree>	getIndividualTemplates()
IChromosomeType[]	getKaryotype()
java.util.Collection<ILeafTickHandler>	getLeafTickHandlers()
ITree	getMember(net.minecraft.item.ItemStack itemstack)
ITree	getMember(net.minecraft.nbt.NBTTagCompound compound)
java.lang.Class<? extends IIndividual>	getMemberClass()
net.minecraft.item.ItemStack	getMemberStack(IIndividual tree, ISpeciesType type)
java.util.List<ITreeMutation>	getMutations(boolean shuffle)
IChromosomeType	getSpeciesChromosomeType()
int	getSpeciesCount()
IDatabasePlugin	getSpeciesPlugin() Plugin to add information for the handheld genetic analyzer and the database.
ITree	getTree(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
ITree	getTree(net.minecraft.world.World world, ITreeGenome genome)
ITreekeepingMode	getTreekeepingMode(java.lang.String name)
ITreekeepingMode	getTreekeepingMode(net.minecraft.world.World world)
java.util.List<ITreekeepingMode>	getTreekeepingModes()
EnumGermlingType	getType(net.minecraft.item.ItemStack stack)
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 itemstack) 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.
boolean	plantSapling(net.minecraft.world.World world, ITree tree, com.mojang.authlib.GameProfile owner, net.minecraft.util.math.BlockPos pos)
void	registerLeafTickHandler(ILeafTickHandler handler) Register a leaf tick handler.
void	registerMutation(IMutation mutation) Use to register mutations.
void	registerTemplate(java.lang.String identifier, IAllele[] template) Registers a bee template using the passed identifier.
void	registerTreekeepingMode(ITreekeepingMode mode)
boolean	setFruitBlock(net.minecraft.world.World world, ITreeGenome genome, IAlleleFruit allele, float yield, net.minecraft.util.math.BlockPos pos)
void	setTreekeepingMode(net.minecraft.world.World world, ITreekeepingMode mode)
ITreeGenome	templateAsGenome(IAllele[] template)
ITreeGenome	templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive)
ITree	templateAsIndividual(IAllele[] template)
ITree	templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive)
IPollinatable	tryConvertToPollinatable(com.mojang.authlib.GameProfile owner, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, IIndividual individual)

Methods inherited from class forestry.core.genetics.SpeciesRoot

getCombinations, getCombinations, getGenomeTemplates, getPaths, getRandomTemplate, getResearchCatalysts, getResultantMutations, getTemplate, getTemplate, getTranslator, registerTemplate, registerTranslator, setResearchSuitability, templateAsChromosomes, templateAsChromosomes, translateMember

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface forestry.api.arboriculture.ITreeRoot

templateAsChromosomes, templateAsChromosomes

Methods inherited from interface forestry.api.genetics.ISpeciesRoot

getCombinations, getCombinations, getGenomeTemplates, getMemberStack, getMemberStack, getPaths, getRandomTemplate, getResearchCatalysts, getResultantMutations, getTemplate, getTemplate, getTranslator, getTypeForMutation, registerTemplate, registerTranslator, setResearchSuitability, translateMember

Field Detail

UID

public static final java.lang.String UID

See Also:

Constant Field Values

treeTemplates

public static final java.util.List<ITree> treeTemplates

Constructor Detail

TreeRoot

public TreeRoot()

Method Detail

getUID

public java.lang.String getUID()

Specified by:

getUID in interface ISpeciesRoot

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

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

Specified by:

getMemberClass in interface ISpeciesRoot

Returns:

Class of the sub-interface inheriting from IIndividual.

getSpeciesCount

public int getSpeciesCount()

Specified by:

getSpeciesCount in interface ISpeciesRoot

Returns:

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

isMember

public boolean isMember(net.minecraft.item.ItemStack itemstack)

Description copied from interface: ISpeciesRoot

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

Specified by:

isMember in interface ITreeRoot

Specified by:

isMember in interface ISpeciesRoot

Parameters:

itemstack - itemstack to check.

Returns:

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

isMember

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

Description copied from interface: ISpeciesRoot

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

Specified by:

isMember in interface ISpeciesRoot

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

public boolean isMember(IIndividual individual)

Description copied from interface: ISpeciesRoot

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

Specified by:

isMember in interface ISpeciesRoot

Parameters:

individual - IIndividual to check.

Returns:

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

getType

@Nullable
public EnumGermlingType getType(net.minecraft.item.ItemStack stack)

Specified by:

getType in interface ITreeRoot

Specified by:

getType in interface ISpeciesRoot

Returns:

type of tree encoded on the itemstack. EnumGermlingType.NONE if it isn't a tree.

getIconType

public EnumGermlingType getIconType()

Description copied from interface: ISpeciesRoot

Species type used to represent this species in icons

Specified by:

getIconType in interface ISpeciesRoot

getTypes

public ISpeciesType[] getTypes()

Specified by:

getTypes in interface ISpeciesRoot

getTree

public ITree getTree(net.minecraft.world.World world,
                     net.minecraft.util.math.BlockPos pos)

Specified by:

getTree in interface ITreeRoot

getMember

@Nullable
public ITree getMember(net.minecraft.item.ItemStack itemstack)

Specified by:

getMember in interface ITreeRoot

Specified by:

getMember in interface ISpeciesRoot

getMember

public ITree getMember(net.minecraft.nbt.NBTTagCompound compound)

Specified by:

getMember in interface ITreeRoot

Specified by:

getMember in interface ISpeciesRoot

getTree

public ITree getTree(net.minecraft.world.World world,
                     ITreeGenome genome)

Specified by:

getTree in interface ITreeRoot

getMemberStack

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

Specified by:

getMemberStack in interface ISpeciesRoot

plantSapling

public boolean plantSapling(net.minecraft.world.World world,
                            ITree tree,
                            com.mojang.authlib.GameProfile owner,
                            net.minecraft.util.math.BlockPos pos)

Specified by:

plantSapling in interface ITreeRoot

setFruitBlock

public boolean setFruitBlock(net.minecraft.world.World world,
                             ITreeGenome genome,
                             IAlleleFruit allele,
                             float yield,
                             net.minecraft.util.math.BlockPos pos)

Specified by:

setFruitBlock in interface ITreeRoot

templateAsGenome

public ITreeGenome templateAsGenome(IAllele[] template)

Specified by:

templateAsGenome in interface ITreeRoot

Specified by:

templateAsGenome in interface ISpeciesRoot

templateAsGenome

public ITreeGenome templateAsGenome(IAllele[] templateActive,
                                    IAllele[] templateInactive)

Specified by:

templateAsGenome in interface ITreeRoot

Specified by:

templateAsGenome in interface ISpeciesRoot

templateAsIndividual

public ITree templateAsIndividual(IAllele[] template)

Specified by:

templateAsIndividual in interface ITreeRoot

Specified by:

templateAsIndividual in interface ISpeciesRoot

templateAsIndividual

public ITree templateAsIndividual(IAllele[] templateActive,
                                  IAllele[] templateInactive)

Specified by:

templateAsIndividual in interface ITreeRoot

Specified by:

templateAsIndividual in interface ISpeciesRoot

getBreedingTracker

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

Specified by:

getBreedingTracker in interface ITreeRoot

Specified by:

getBreedingTracker in interface ISpeciesRoot

Returns:

IArboristTracker associated with the passed world.

getTreekeepingModes

public java.util.List<ITreekeepingMode> getTreekeepingModes()

Specified by:

getTreekeepingModes in interface ITreeRoot

getTreekeepingMode

public ITreekeepingMode getTreekeepingMode(net.minecraft.world.World world)

Specified by:

getTreekeepingMode in interface ITreeRoot

registerTreekeepingMode

public void registerTreekeepingMode(ITreekeepingMode mode)

Specified by:

registerTreekeepingMode in interface ITreeRoot

setTreekeepingMode

public void setTreekeepingMode(net.minecraft.world.World world,
                               ITreekeepingMode mode)

Specified by:

setTreekeepingMode in interface ITreeRoot

getTreekeepingMode

public ITreekeepingMode getTreekeepingMode(java.lang.String name)

Specified by:

getTreekeepingMode in interface ITreeRoot

getIndividualTemplates

public java.util.List<ITree> getIndividualTemplates()

Specified by:

getIndividualTemplates in interface ITreeRoot

Specified by:

getIndividualTemplates in interface ISpeciesRoot

registerTemplate

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

Description copied from interface: ISpeciesRoot

Registers a bee template using the passed identifier.

Specified by:

registerTemplate in interface ISpeciesRoot

getDefaultTemplate

public IAllele[] getDefaultTemplate()

Specified by:

getDefaultTemplate in interface ISpeciesRoot

Returns:

Default individual template for use when stuff breaks.

getMutations

public java.util.List<ITreeMutation> getMutations(boolean shuffle)

Specified by:

getMutations in interface ITreeRoot

Specified by:

getMutations in interface ISpeciesRoot

Returns:

All registered mutations.

registerMutation

public void registerMutation(IMutation mutation)

Description copied from interface: ISpeciesRoot

Use to register mutations.

Specified by:

registerMutation in interface ISpeciesRoot

registerLeafTickHandler

public void registerLeafTickHandler(ILeafTickHandler handler)

Description copied from interface: ITreeRoot

Register a leaf tick handler.

Specified by:

registerLeafTickHandler in interface ITreeRoot

Parameters:

handler - the ILeafTickHandler to register.

getLeafTickHandlers

public java.util.Collection<ILeafTickHandler> getLeafTickHandlers()

Specified by:

getLeafTickHandlers in interface ITreeRoot

getKaryotype

public IChromosomeType[] getKaryotype()

Specified by:

getKaryotype in interface ISpeciesRoot

Returns:

Array of all IChromosomeType which are in this species genome

getSpeciesChromosomeType

public IChromosomeType getSpeciesChromosomeType()

Specified by:

getSpeciesChromosomeType in interface ISpeciesRoot

Returns:

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

getAlyzerPlugin

public IAlyzerPlugin getAlyzerPlugin()

Description copied from interface: ISpeciesRoot

Plugin to add information for the handheld genetic analyzer.

Specified by:

getAlyzerPlugin in interface ISpeciesRoot

getSpeciesPlugin

public IDatabasePlugin getSpeciesPlugin()

Description copied from interface: ISpeciesRoot

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

Specified by:

getSpeciesPlugin in interface ISpeciesRoot

createPollinatable

public ICheckPollinatable createPollinatable(IIndividual individual)

Specified by:

createPollinatable in interface ISpeciesRootPollinatable

tryConvertToPollinatable

@Nullable
public IPollinatable tryConvertToPollinatable(@Nullable
                                                        com.mojang.authlib.GameProfile owner,
                                                        net.minecraft.world.World world,
                                                        net.minecraft.util.math.BlockPos pos,
                                                        IIndividual individual)

Specified by:

tryConvertToPollinatable in interface ISpeciesRootPollinatable

getFruitProvidersForFruitFamily

public java.util.Collection<IFruitProvider> getFruitProvidersForFruitFamily(IFruitFamily fruitFamily)

Specified by:

getFruitProvidersForFruitFamily in interface ITreeRoot