forestry.api.genetics

Interface IMutation

All Known Subinterfaces:

IBeeMutation, IButterflyMutation, ITreeMutation

All Known Implementing Classes:

BeeMutation, ButterflyMutation, Mutation, TreeMutation

public interface IMutation

Individuals can be seeded either as hive drops or as mutation results.

IAlleleRegistry manages these.

Method Summary

Modifier and Type	Method and Description
IAlleleSpecies	getAllele0()
IAlleleSpecies	getAllele1()
float	getBaseChance()
IAllele	getPartner(IAllele allele)
ISpeciesRoot	getRoot()
java.util.Collection<java.lang.String>	getSpecialConditions()
IAllele[]	getTemplate()
boolean	isPartner(IAllele allele)
boolean	isSecret()

Method Detail

getRoot

ISpeciesRoot getRoot()

Returns:

ISpeciesRoot this mutation is associated with.

getAllele0

IAlleleSpecies getAllele0()

Returns:

first of the alleles implementing IAlleleSpecies required for this mutation.

getAllele1

IAlleleSpecies getAllele1()

Returns:

second of the alleles implementing IAlleleSpecies required for this mutation.

getTemplate

IAllele[] getTemplate()

Returns:

Array of IAllele representing the full default genome of the mutated side.

Make sure to return a proper array for the species class. Returning an allele of the wrong type will cause cast errors on runtime.

getBaseChance

float getBaseChance()

Returns:

Unmodified base chance for mutation to fire.

getSpecialConditions

java.util.Collection<java.lang.String> getSpecialConditions()

Returns:

Collection of localized, human-readable strings describing special mutation conditions, if any.

isPartner

boolean isPartner(IAllele allele)

Returns:

true if the passed allele is one of the alleles participating in this mutation.

getPartner

IAllele getPartner(IAllele allele)

Returns:

the other allele which was not passed as argument.

isSecret

boolean isSecret()

Returns:

true if the mutation should not be displayed in the beealyzer.