forestry.apiculture.genetics

Class BeeRoot

java.lang.Object

forestry.core.genetics.SpeciesRoot

forestry.apiculture.genetics.BeeRoot

All Implemented Interfaces:

IBeeRoot, ISpeciesRoot

public class BeeRoot
extends SpeciesRoot
implements IBeeRoot

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UID

Fields inherited from class forestry.core.genetics.SpeciesRoot

speciesTemplates

Constructor Summary

Constructors

Constructor and Description
BeeRoot()

Method Summary

Modifier and Type	Method and Description
IBeeListener	createBeeHousingListener(IBeeHousing housing) Combines multiple listeners from an IBeeHousing into one.
IBeeModifier	createBeeHousingModifier(IBeeHousing housing) Combines multiple modifiers from an IBeeHousing into one.
IBeekeepingLogic	createBeekeepingLogic(IBeeHousing housing) Creates beekeepingLogic for a housing.
IAlyzerPlugin	getAlyzerPlugin() Plugin to add information for the handheld genetic analyzer.
IBee	getBee(IBeeGenome genome)
IBee	getBee(net.minecraft.world.World world, IBeeGenome genome, IBee mate) Creates an IBee suitable for a queen containing the necessary second genome for the mate.
IBeekeepingMode	getBeekeepingMode(java.lang.String name)
IBeekeepingMode	getBeekeepingMode(net.minecraft.world.World world)
java.util.List<IBeekeepingMode>	getBeekeepingModes()
IApiaristTracker	getBreedingTracker(net.minecraft.world.World world, com.mojang.authlib.GameProfile player)
IAllele[]	getDefaultTemplate()
EnumBeeType	getIconType() Species type used to represent this species in icons
java.util.List<IBee>	getIndividualTemplates()
IChromosomeType[]	getKaryotype()
IBee	getMember(net.minecraft.item.ItemStack stack)
IBee	getMember(net.minecraft.nbt.NBTTagCompound compound)
java.lang.Class<? extends IIndividual>	getMemberClass()
net.minecraft.item.ItemStack	getMemberStack(IIndividual individual, ISpeciesType type)
java.util.List<IBeeMutation>	getMutations(boolean shuffle)
IChromosomeType	getSpeciesChromosomeType()
int	getSpeciesCount()
IDatabasePlugin	getSpeciesPlugin() Plugin to add information for the handheld genetic analyzer and the database.
EnumBeeType	getType(net.minecraft.item.ItemStack stack)
ISpeciesType	getTypeForMutation(int position) The type of the species that will be used at the given position of the mutation recipe in the gui.
ISpeciesType[]	getTypes()
java.lang.String	getUID()
boolean	isDrone(net.minecraft.item.ItemStack stack)
boolean	isMated(net.minecraft.item.ItemStack stack)
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	registerBeekeepingMode(IBeekeepingMode mode)
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	resetBeekeepingMode()
void	setBeekeepingMode(net.minecraft.world.World world, IBeekeepingMode mode)
IBeeGenome	templateAsGenome(IAllele[] template)
IBeeGenome	templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive)
IBee	templateAsIndividual(IAllele[] template)
IBee	templateAsIndividual(IAllele[] templateActive, IAllele[] templateInactive)

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.genetics.ISpeciesRoot

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

Field Detail

UID

public static final java.lang.String UID

See Also:

Constant Field Values

Constructor Detail

BeeRoot

public BeeRoot()

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 stack)

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 IBeeRoot

Specified by:

isMember in interface ISpeciesRoot

Parameters:

stack - itemstack to check.

Returns:

true if passed item is a Forestry bee. Equal to getType(ItemStack stack) != null

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.

getMemberStack

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

Specified by:

getMemberStack in interface ISpeciesRoot

getType

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

Specified by:

getType in interface IBeeRoot

Specified by:

getType in interface ISpeciesRoot

Returns:

type of bee encoded on the itemstack. null if it isn't a bee.

getIconType

public EnumBeeType 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

getTypeForMutation

public ISpeciesType getTypeForMutation(int position)

Description copied from interface: ISpeciesRoot

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

Specified by:

getTypeForMutation in interface ISpeciesRoot

Parameters:

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

isDrone

public boolean isDrone(net.minecraft.item.ItemStack stack)

Specified by:

isDrone in interface IBeeRoot

Returns:

true if passed item is a drone. Equal to getType(ItemStack stack) == EnumBeeType.DRONE

isMated

public boolean isMated(net.minecraft.item.ItemStack stack)

Specified by:

isMated in interface IBeeRoot

Returns:

true if passed item is mated (i.e. a queen)

getMember

@Nullable
public IBee getMember(net.minecraft.item.ItemStack stack)

Specified by:

getMember in interface IBeeRoot

Specified by:

getMember in interface ISpeciesRoot

Returns:

IBee pattern parsed from the passed stack's nbt data. Null if the ItemStack is not a valid member.

getMember

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

Specified by:

getMember in interface IBeeRoot

Specified by:

getMember in interface ISpeciesRoot

getBee

public IBee getBee(IBeeGenome genome)

Specified by:

getBee in interface IBeeRoot

Parameters:

genome - Valid IBeeGenome

Returns:

IBee from the passed genome

getBee

public IBee getBee(net.minecraft.world.World world,
                   IBeeGenome genome,
                   IBee mate)

Description copied from interface: IBeeRoot

Creates an IBee suitable for a queen containing the necessary second genome for the mate.

Specified by:

getBee in interface IBeeRoot

genome - Valid IBeeGenome

mate - Valid IBee representing the mate.

Returns:

Mated IBee from the passed genomes.

templateAsGenome

public IBeeGenome templateAsGenome(IAllele[] template)

Specified by:

templateAsGenome in interface IBeeRoot

Specified by:

templateAsGenome in interface ISpeciesRoot

templateAsGenome

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

Specified by:

templateAsGenome in interface IBeeRoot

Specified by:

templateAsGenome in interface ISpeciesRoot

templateAsIndividual

public IBee templateAsIndividual(IAllele[] template)

Specified by:

templateAsIndividual in interface IBeeRoot

Specified by:

templateAsIndividual in interface ISpeciesRoot

templateAsIndividual

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

Specified by:

templateAsIndividual in interface IBeeRoot

Specified by:

templateAsIndividual in interface ISpeciesRoot

getIndividualTemplates

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

Specified by:

getIndividualTemplates in interface IBeeRoot

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<IBeeMutation> getMutations(boolean shuffle)

Specified by:

getMutations in interface IBeeRoot

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

resetBeekeepingMode

public void resetBeekeepingMode()

Specified by:

resetBeekeepingMode in interface IBeeRoot

getBeekeepingModes

public java.util.List<IBeekeepingMode> getBeekeepingModes()

Specified by:

getBeekeepingModes in interface IBeeRoot

getBeekeepingMode

public IBeekeepingMode getBeekeepingMode(net.minecraft.world.World world)

Specified by:

getBeekeepingMode in interface IBeeRoot

registerBeekeepingMode

public void registerBeekeepingMode(IBeekeepingMode mode)

Specified by:

registerBeekeepingMode in interface IBeeRoot

setBeekeepingMode

public void setBeekeepingMode(net.minecraft.world.World world,
                              IBeekeepingMode mode)

Specified by:

setBeekeepingMode in interface IBeeRoot

getBeekeepingMode

public IBeekeepingMode getBeekeepingMode(java.lang.String name)

Specified by:

getBeekeepingMode in interface IBeeRoot

getBreedingTracker

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

Specified by:

getBreedingTracker in interface IBeeRoot

Specified by:

getBreedingTracker in interface ISpeciesRoot

Returns:

IApiaristTracker associated with the passed world.

createBeekeepingLogic

public IBeekeepingLogic createBeekeepingLogic(IBeeHousing housing)

Description copied from interface: IBeeRoot

Creates beekeepingLogic for a housing. Should be used when the housing is created, see IBeekeepingLogic

Specified by:

createBeekeepingLogic in interface IBeeRoot

createBeeHousingModifier

public IBeeModifier createBeeHousingModifier(IBeeHousing housing)

Description copied from interface: IBeeRoot

Combines multiple modifiers from an IBeeHousing into one. Stays up to date with changes to the housing's modifiers.

Specified by:

createBeeHousingModifier in interface IBeeRoot

createBeeHousingListener

public IBeeListener createBeeHousingListener(IBeeHousing housing)

Description copied from interface: IBeeRoot

Combines multiple listeners from an IBeeHousing into one. Stays up to date with changes to the housing's listeners.

Specified by:

createBeeHousingListener in interface IBeeRoot

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