forestry.lepidopterology.genetics

Class ButterflyRoot

java.lang.Object

forestry.core.genetics.SpeciesRoot

forestry.lepidopterology.genetics.ButterflyRoot

All Implemented Interfaces:

ISpeciesRoot, IButterflyRoot

public class ButterflyRoot
extends SpeciesRoot
implements IButterflyRoot

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
ButterflyRoot()

Method Summary

Modifier and Type	Method and Description
IAlyzerPlugin	getAlyzerPlugin() Plugin to add information for the handheld genetic analyzer.
ILepidopteristTracker	getBreedingTracker(net.minecraft.world.World world, com.mojang.authlib.GameProfile player)
IAllele[]	getDefaultTemplate()
EnumFlutterType	getIconType() Species type used to represent this species in icons
java.util.List<IButterfly>	getIndividualTemplates()
IChromosomeType[]	getKaryotype()
IButterfly	getMember(net.minecraft.item.ItemStack stack)
IButterfly	getMember(net.minecraft.nbt.NBTTagCompound compound)
java.lang.Class<? extends IIndividual>	getMemberClass()
net.minecraft.item.ItemStack	getMemberStack(IIndividual butterfly, ISpeciesType type)
java.util.List<IButterflyMutation>	getMutations(boolean shuffle)
IChromosomeType	getSpeciesChromosomeType()
int	getSpeciesCount()
IDatabasePlugin	getSpeciesPlugin() Plugin to add information for the handheld genetic analyzer and the database.
EnumFlutterType	getType(net.minecraft.item.ItemStack stack)
ISpeciesType[]	getTypes()
java.lang.String	getUID()
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.
boolean	isPositionValid(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, IButterfly caterpillar, com.mojang.authlib.GameProfile gameProfile, boolean createNursery) Deprecated. Call isPositionValid(World, BlockPos, GameProfile, boolean) without a caterpillar parameter.
net.minecraft.util.math.BlockPos	plantCocoon(net.minecraft.world.World world, net.minecraft.util.math.BlockPos coordinates, IButterfly caterpillar, com.mojang.authlib.GameProfile owner, int age, boolean createNursery)
void	registerMutation(IMutation mutation) Use to register mutations.
void	registerTemplate(java.lang.String identifier, IAllele[] template) Registers a bee template using the passed identifier.
EntityButterfly	spawnButterflyInWorld(net.minecraft.world.World world, IButterfly butterfly, double x, double y, double z) Spawns the given butterfly in the world.
IButterflyGenome	templateAsGenome(IAllele[] template)
IButterflyGenome	templateAsGenome(IAllele[] templateActive, IAllele[] templateInactive)
IButterfly	templateAsIndividual(IAllele[] template)
IButterfly	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, getTypeForMutation, registerTemplate, registerTranslator, setResearchSuitability, templateAsChromosomes, templateAsChromosomes, translateMember

Field Detail

UID

public static final java.lang.String UID

See Also:

Constant Field Values

Constructor Detail

ButterflyRoot

public ButterflyRoot()

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 ISpeciesRoot

Specified by:

isMember in interface IButterflyRoot

Parameters:

stack - itemstack to check.

Returns:

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

getType

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

Specified by:

getType in interface ISpeciesRoot

Specified by:

getType in interface IButterflyRoot

getIconType

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

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.

getMember

public IButterfly getMember(net.minecraft.item.ItemStack stack)

Specified by:

getMember in interface ISpeciesRoot

Specified by:

getMember in interface IButterflyRoot

getMember

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

Specified by:

getMember in interface ISpeciesRoot

Specified by:

getMember in interface IButterflyRoot

getMemberStack

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

Specified by:

getMemberStack in interface ISpeciesRoot

spawnButterflyInWorld

public EntityButterfly spawnButterflyInWorld(net.minecraft.world.World world,
                                             IButterfly butterfly,
                                             double x,
                                             double y,
                                             double z)

Description copied from interface: IButterflyRoot

Spawns the given butterfly in the world.

Specified by:

spawnButterflyInWorld in interface IButterflyRoot

Returns:

butterfly entity on success, null otherwise.

plantCocoon

public net.minecraft.util.math.BlockPos plantCocoon(net.minecraft.world.World world,
                                                    net.minecraft.util.math.BlockPos coordinates,
                                                    @Nullable
                                                    IButterfly caterpillar,
                                                    com.mojang.authlib.GameProfile owner,
                                                    int age,
                                                    boolean createNursery)

Specified by:

plantCocoon in interface IButterflyRoot

isPositionValid

@Deprecated
public boolean isPositionValid(net.minecraft.world.World world,
                                           net.minecraft.util.math.BlockPos pos,
                                           @Nullable
                                           IButterfly caterpillar,
                                           com.mojang.authlib.GameProfile gameProfile,
                                           boolean createNursery)

Deprecated. Call isPositionValid(World, BlockPos, GameProfile, boolean) without a caterpillar parameter.

isMated

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

Specified by:

isMated in interface IButterflyRoot

Returns:

true if passed item is mated.

templateAsIndividual

public IButterfly templateAsIndividual(IAllele[] template)

Specified by:

templateAsIndividual in interface ISpeciesRoot

Specified by:

templateAsIndividual in interface IButterflyRoot

templateAsIndividual

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

Specified by:

templateAsIndividual in interface ISpeciesRoot

Specified by:

templateAsIndividual in interface IButterflyRoot

templateAsGenome

public IButterflyGenome templateAsGenome(IAllele[] template)

Specified by:

templateAsGenome in interface ISpeciesRoot

Specified by:

templateAsGenome in interface IButterflyRoot

templateAsGenome

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

Specified by:

templateAsGenome in interface ISpeciesRoot

Specified by:

templateAsGenome in interface IButterflyRoot

getIndividualTemplates

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

Specified by:

getIndividualTemplates in interface ISpeciesRoot

Specified by:

getIndividualTemplates in interface IButterflyRoot

getDefaultTemplate

public IAllele[] getDefaultTemplate()

Specified by:

getDefaultTemplate in interface ISpeciesRoot

Returns:

Default individual template for use when stuff breaks.

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

registerMutation

public void registerMutation(IMutation mutation)

Description copied from interface: ISpeciesRoot

Use to register mutations.

Specified by:

registerMutation in interface ISpeciesRoot

getMutations

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

Specified by:

getMutations in interface ISpeciesRoot

Specified by:

getMutations in interface IButterflyRoot

Returns:

All registered mutations.

getBreedingTracker

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

Specified by:

getBreedingTracker in interface ISpeciesRoot

Specified by:

getBreedingTracker in interface IButterflyRoot

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