forestry.api.genetics

Interface IAlleleSpecies

All Superinterfaces:

IAllele

All Known Subinterfaces:

IAlleleBeeSpecies, IAlleleButterflySpecies, IAlleleTreeSpecies

All Known Implementing Classes:

AlleleBeeSpecies, AlleleButterflySpecies, AlleleSpecies, AlleleTreeSpecies

public interface IAlleleSpecies
extends IAllele

Basic species allele.

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 gameProfile, IIndividual individual, int bountyLevel)
float	getResearchSuitability(net.minecraft.item.ItemStack itemstack)
ISpeciesRoot	getRoot()
int	getSpriteColour(int renderPass)
EnumTemperature	getTemperature()
boolean	hasEffect()
boolean	isCounted()
boolean	isSecret()

Methods inherited from interface forestry.api.genetics.IAllele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant

Method Detail

getRoot

ISpeciesRoot getRoot()

Returns:

the ISpeciesRoot associated with this species.

getDescription

java.lang.String getDescription()

Returns:

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

getBinomial

java.lang.String getBinomial()

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.

Returns:

flavour text

getAuthority

java.lang.String getAuthority()

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

Returns:

flavour text

getBranch

IClassification getBranch()

Returns:

Branch this species is associated with.

getComplexity

int getComplexity()

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.

Returns:

Values between 3 - 11 are useful.

getResearchSuitability

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

Returns:

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

getResearchBounty

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

Returns:

itemstacks representing the bounty for this research success.

getTemperature

EnumTemperature getTemperature()

Returns:

Preferred temperature

getHumidity

EnumHumidity getHumidity()

Returns:

Preferred humidity

hasEffect

boolean hasEffect()

Returns:

true if the species icon should have a glowing effect.

isSecret

boolean isSecret()

Returns:

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

isCounted

boolean isCounted()

Returns:

true to have the species count against the species total.

getSpriteColour

int getSpriteColour(int renderPass)

Parameters:

renderPass - Render pass to get the colour for.

Returns:

Colour to use for the render pass.