forestry.core.genetics.alleles

Class AlleleSpecies

java.lang.Object

forestry.core.genetics.alleles.Allele

forestry.core.genetics.alleles.AlleleSpecies

All Implemented Interfaces:

IAllele, IAlleleSpecies, IAlleleSpeciesBuilder

Direct Known Subclasses:

AlleleBeeSpecies, AlleleButterflySpecies, AlleleTreeSpecies

public abstract class AlleleSpecies
extends Allele
implements IAlleleSpeciesBuilder, IAlleleSpecies

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlleleSpecies(java.lang.String modId, java.lang.String uid, java.lang.String unlocalizedName, java.lang.String authority, java.lang.String unlocalizedDescription, boolean isDominant, IClassification branch, java.lang.String binomial)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthority() Authority for the binomial name, e.g.
java.lang.String	getBinomial() Binomial name of the species sans genus ("Apis").
IClassification	getBranch()
int	getComplexity() Complexity determines the difficulty researching a species.
java.lang.String	getDescription()
EnumHumidity	getHumidity()
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getResearchBounty(net.minecraft.world.World world, com.mojang.authlib.GameProfile researcher, IIndividual individual, int bountyLevel)
float	getResearchSuitability(net.minecraft.item.ItemStack itemstack)
EnumTemperature	getTemperature()
boolean	hasEffect()
boolean	isCounted()
boolean	isSecret()
void	setComplexity(int complexity) Manually the genetic complexity.
IAlleleSpeciesBuilder	setHasEffect()
IAlleleSpeciesBuilder	setHumidity(EnumHumidity humidity)
IAlleleSpeciesBuilder	setIsNotCounted() Uncounted species do not count toward total species discovered.
IAlleleSpeciesBuilder	setIsSecret() Secret species are not shown in creative mode.
IAlleleSpeciesBuilder	setTemperature(EnumTemperature temperature)

Methods inherited from class forestry.core.genetics.alleles.Allele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.api.genetics.IAlleleSpeciesBuilder

build

Methods inherited from interface forestry.api.genetics.IAlleleSpecies

getRoot, getSpriteColour

Methods inherited from interface forestry.api.genetics.IAllele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant

Constructor Detail

AlleleSpecies

protected AlleleSpecies(java.lang.String modId,
                        java.lang.String uid,
                        java.lang.String unlocalizedName,
                        java.lang.String authority,
                        java.lang.String unlocalizedDescription,
                        boolean isDominant,
                        IClassification branch,
                        java.lang.String binomial)

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IAlleleSpecies

Returns:

Localized short description of this species. (May be null.)

getResearchSuitability

public float getResearchSuitability(net.minecraft.item.ItemStack itemstack)

Specified by:

getResearchSuitability in interface IAlleleSpecies

Returns:

A float signifying the chance for the passed itemstack to yield a research success.

getComplexity

public int getComplexity()

Description copied from interface: IAlleleSpecies

Complexity determines the difficulty researching a species. The values of primary and secondary are added together (and rounded) to determine the amount of pairs needed for successful research.

Specified by:

getComplexity in interface IAlleleSpecies

Returns:

Values between 3 - 11 are useful.

setComplexity

public void setComplexity(int complexity)

Description copied from interface: IAlleleSpeciesBuilder

Manually the genetic complexity. If this is not set, the complexity is based on the number of breeding steps to reach this species.

Specified by:

setComplexity in interface IAlleleSpeciesBuilder

See Also:

IAlleleSpecies.getComplexity()

getResearchBounty

public net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getResearchBounty(net.minecraft.world.World world,
                                                                                      com.mojang.authlib.GameProfile researcher,
                                                                                      IIndividual individual,
                                                                                      int bountyLevel)

Specified by:

getResearchBounty in interface IAlleleSpecies

Returns:

itemstacks representing the bounty for this research success.

getTemperature

public EnumTemperature getTemperature()

Specified by:

getTemperature in interface IAlleleSpecies

Returns:

Preferred temperature

getHumidity

public EnumHumidity getHumidity()

Specified by:

getHumidity in interface IAlleleSpecies

Returns:

Preferred humidity

hasEffect

public boolean hasEffect()

Specified by:

hasEffect in interface IAlleleSpecies

Returns:

true if the species icon should have a glowing effect.

isSecret

public boolean isSecret()

Specified by:

isSecret in interface IAlleleSpecies

Returns:

true if the species should not be displayed in NEI or creative inventory.

isCounted

public boolean isCounted()

Specified by:

isCounted in interface IAlleleSpecies

Returns:

true to have the species count against the species total.

getBinomial

public java.lang.String getBinomial()

Description copied from interface: IAlleleSpecies

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

Specified by:

getBinomial in interface IAlleleSpecies

Returns:

flavour text

getAuthority

public java.lang.String getAuthority()

Description copied from interface: IAlleleSpecies

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

Specified by:

getAuthority in interface IAlleleSpecies

Returns:

flavour text

getBranch

public IClassification getBranch()

Specified by:

getBranch in interface IAlleleSpecies

Returns:

Branch this species is associated with.

setTemperature

public IAlleleSpeciesBuilder setTemperature(EnumTemperature temperature)

Specified by:

setTemperature in interface IAlleleSpeciesBuilder

setHumidity

public IAlleleSpeciesBuilder setHumidity(EnumHumidity humidity)

Specified by:

setHumidity in interface IAlleleSpeciesBuilder

setHasEffect

public IAlleleSpeciesBuilder setHasEffect()

Specified by:

setHasEffect in interface IAlleleSpeciesBuilder

setIsSecret

public IAlleleSpeciesBuilder setIsSecret()

Description copied from interface: IAlleleSpeciesBuilder

Secret species are not shown in creative mode.

Specified by:

setIsSecret in interface IAlleleSpeciesBuilder

setIsNotCounted

public IAlleleSpeciesBuilder setIsNotCounted()

Description copied from interface: IAlleleSpeciesBuilder

Uncounted species do not count toward total species discovered.

Specified by:

setIsNotCounted in interface IAlleleSpeciesBuilder