forestry.lepidopterology.genetics.alleles

Class AlleleButterflyEffect

java.lang.Object

forestry.core.genetics.alleles.Allele

forestry.core.genetics.alleles.AlleleCategorized

forestry.lepidopterology.genetics.alleles.AlleleButterflyEffect

All Implemented Interfaces:

IAllele, IAlleleEffect, IAlleleButterflyEffect

Direct Known Subclasses:

AlleleButterflyEffectNone

public class AlleleButterflyEffect
extends AlleleCategorized
implements IAlleleButterflyEffect

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlleleButterflyEffect(java.lang.String valueName, boolean isDominant)

Method Summary

Modifier and Type	Method and Description
IEffectData	doEffect(IEntityButterfly butterfly, IEffectData storedData) Used by butterflies to trigger effects in the world.
boolean	isCombinable()
IEffectData	validateStorage(IEffectData storedData) Returns the passed data storage if it is valid for this effect or a new one if the passed storage object was invalid for this effect.

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.IAllele

getAlleleName, getModID, getName, getUID, getUnlocalizedName, isDominant

Constructor Detail

AlleleButterflyEffect

protected AlleleButterflyEffect(java.lang.String valueName,
                                boolean isDominant)

Method Detail

isCombinable

public boolean isCombinable()

Specified by:

isCombinable in interface IAlleleEffect

Returns:

true if this effect can combine with the effect on other allele (i.e. run before or after). combination can only occur if both effects are combinable.

validateStorage

public IEffectData validateStorage(IEffectData storedData)

Description copied from interface: IAlleleEffect

Returns the passed data storage if it is valid for this effect or a new one if the passed storage object was invalid for this effect.

Specified by:

validateStorage in interface IAlleleEffect

Returns:

IEffectData for the next cycle.

doEffect

public IEffectData doEffect(IEntityButterfly butterfly,
                            IEffectData storedData)

Description copied from interface: IAlleleButterflyEffect

Used by butterflies to trigger effects in the world.

Specified by:

doEffect in interface IAlleleButterflyEffect

Parameters:

butterfly - IEntityButterfly

Returns:

IEffectData for the next cycle.