forestry.core.genetics.mutations

Class Mutation

java.lang.Object

forestry.core.genetics.mutations.Mutation

All Implemented Interfaces:

IMutation, IMutationBuilder

Direct Known Subclasses:

BeeMutation, ButterflyMutation, TreeMutation

public abstract class Mutation
extends java.lang.Object
implements IMutation, IMutationBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Mutation(IAlleleSpecies species0, IAlleleSpecies species1, IAllele[] template, int chance)

Method Summary

Modifier and Type	Method and Description
Mutation	addMutationCondition(IMutationCondition mutationCondition) Require some other custom mutation condition
IAlleleSpecies	getAllele0()
IAlleleSpecies	getAllele1()
float	getBaseChance()
protected float	getChance(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, IAllele allele0, IAllele allele1, IGenome genome0, IGenome genome1, IClimateProvider climate)
IAllele	getPartner(IAllele allele)
java.util.Collection<java.lang.String>	getSpecialConditions()
IAllele[]	getTemplate()
boolean	isPartner(IAllele allele)
boolean	isSecret()
Mutation	requireDay() Restrict the time of day that this mutation can occur
Mutation	requireNight()
Mutation	requireResource(net.minecraft.block.state.IBlockState... acceptedBlockStates) Require a specific resource to be under the location of the mutation
Mutation	requireResource(java.lang.String oreName)
Mutation	restrictBiomeType(net.minecraftforge.common.BiomeDictionary.Type... types) Restrict this mutation to certain types of biomes.
Mutation	restrictDateRange(int startMonth, int startDay, int endMonth, int endDay) Restrict the days of the year that this mutation can occur
Mutation	restrictHumidity(EnumHumidity humidity) Require a specific humidity for this mutation to occur
Mutation	restrictHumidity(EnumHumidity minHumidity, EnumHumidity maxHumidity)
Mutation	restrictTemperature(EnumTemperature temperature) Require a specific temperature for this mutation to occur
Mutation	restrictTemperature(EnumTemperature minTemperature, EnumTemperature maxTemperature)
Mutation	setIsSecret() Prevent this mutation from being shown in the analyzers
java.lang.String	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.IMutation

getRoot

Methods inherited from interface forestry.api.genetics.IMutationBuilder

build

Constructor Detail

Mutation

protected Mutation(IAlleleSpecies species0,
                   IAlleleSpecies species1,
                   IAllele[] template,
                   int chance)

Method Detail

getSpecialConditions

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

Specified by:

getSpecialConditions in interface IMutation

Returns:

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

setIsSecret

public Mutation setIsSecret()

Description copied from interface: IMutationBuilder

Prevent this mutation from being shown in the analyzers

Specified by:

setIsSecret in interface IMutationBuilder

restrictTemperature

public Mutation restrictTemperature(EnumTemperature temperature)

Description copied from interface: IMutationBuilder

Require a specific temperature for this mutation to occur

Specified by:

restrictTemperature in interface IMutationBuilder

restrictTemperature

public Mutation restrictTemperature(EnumTemperature minTemperature,
                                    EnumTemperature maxTemperature)

Specified by:

restrictTemperature in interface IMutationBuilder

restrictHumidity

public Mutation restrictHumidity(EnumHumidity humidity)

Description copied from interface: IMutationBuilder

Require a specific humidity for this mutation to occur

Specified by:

restrictHumidity in interface IMutationBuilder

restrictHumidity

public Mutation restrictHumidity(EnumHumidity minHumidity,
                                 EnumHumidity maxHumidity)

Specified by:

restrictHumidity in interface IMutationBuilder

restrictBiomeType

public Mutation restrictBiomeType(net.minecraftforge.common.BiomeDictionary.Type... types)

Description copied from interface: IMutationBuilder

Restrict this mutation to certain types of biomes.

Specified by:

restrictBiomeType in interface IMutationBuilder

Parameters:

types - The types of biomes this mutation can occur.

requireDay

public Mutation requireDay()

Description copied from interface: IMutationBuilder

Restrict the time of day that this mutation can occur

Specified by:

requireDay in interface IMutationBuilder

requireNight

public Mutation requireNight()

Specified by:

requireNight in interface IMutationBuilder

restrictDateRange

public Mutation restrictDateRange(int startMonth,
                                  int startDay,
                                  int endMonth,
                                  int endDay)

Description copied from interface: IMutationBuilder

Restrict the days of the year that this mutation can occur

Specified by:

restrictDateRange in interface IMutationBuilder

requireResource

public Mutation requireResource(net.minecraft.block.state.IBlockState... acceptedBlockStates)

Description copied from interface: IMutationBuilder

Require a specific resource to be under the location of the mutation

Specified by:

requireResource in interface IMutationBuilder

requireResource

public Mutation requireResource(java.lang.String oreName)

Specified by:

requireResource in interface IMutationBuilder

addMutationCondition

public Mutation addMutationCondition(IMutationCondition mutationCondition)

Description copied from interface: IMutationBuilder

Require some other custom mutation condition

Specified by:

addMutationCondition in interface IMutationBuilder

getChance

protected float getChance(net.minecraft.world.World world,
                          net.minecraft.util.math.BlockPos pos,
                          IAllele allele0,
                          IAllele allele1,
                          IGenome genome0,
                          IGenome genome1,
                          IClimateProvider climate)

getAllele0

public IAlleleSpecies getAllele0()

Specified by:

getAllele0 in interface IMutation

Returns:

first of the alleles implementing IAlleleSpecies required for this mutation.

getAllele1

public IAlleleSpecies getAllele1()

Specified by:

getAllele1 in interface IMutation

Returns:

second of the alleles implementing IAlleleSpecies required for this mutation.

getBaseChance

public float getBaseChance()

Specified by:

getBaseChance in interface IMutation

Returns:

Unmodified base chance for mutation to fire.

getTemplate

public IAllele[] getTemplate()

Specified by:

getTemplate in interface IMutation

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.

isPartner

public boolean isPartner(IAllele allele)

Specified by:

isPartner in interface IMutation

Returns:

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

getPartner

public IAllele getPartner(IAllele allele)

Specified by:

getPartner in interface IMutation

Returns:

the other allele which was not passed as argument.

isSecret

public boolean isSecret()

Specified by:

isSecret in interface IMutation

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object