forestry.apiculture.genetics.alleles

Class AlleleEffectThrottled

java.lang.Object

forestry.core.genetics.alleles.Allele

forestry.core.genetics.alleles.AlleleCategorized

forestry.apiculture.genetics.alleles.AlleleEffect

forestry.apiculture.genetics.alleles.AlleleEffectThrottled

All Implemented Interfaces:

IAlleleBeeEffect, IAllele, IAlleleEffect

Direct Known Subclasses:

AlleleEffectAggressive, AlleleEffectCreeper, AlleleEffectExploration, AlleleEffectFertile, AlleleEffectFungification, AlleleEffectGlacial, AlleleEffectHeroic, AlleleEffectIgnition, AlleleEffectMisanthrope, AlleleEffectPotion, AlleleEffectRadioactive, AlleleEffectRepulsion, AlleleEffectResurrection, AlleleEffectSnowing

public abstract class AlleleEffectThrottled
extends AlleleEffect

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlleleEffectThrottled(java.lang.String name, boolean isDominant, int throttle, boolean requiresWorking, boolean isCombinable)

Method Summary

Modifier and Type	Method and Description
IEffectData	doEffect(IBeeGenome genome, IEffectData storedData, IBeeHousing housing) Called by apiaries to cause an effect 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.apiculture.genetics.alleles.AlleleEffect

doFX, getBounding, getEntitiesInRange, getModifiedArea

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

AlleleEffectThrottled

protected AlleleEffectThrottled(java.lang.String name,
                                boolean isDominant,
                                int throttle,
                                boolean requiresWorking,
                                boolean isCombinable)

Method Detail

isCombinable

public boolean isCombinable()

Specified by:

isCombinable in interface IAlleleEffect

Overrides:

isCombinable in class AlleleEffect

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

Overrides:

validateStorage in class AlleleEffect

Returns:

IEffectData for the next cycle.

doEffect

public final IEffectData doEffect(IBeeGenome genome,
                                  IEffectData storedData,
                                  IBeeHousing housing)

Description copied from interface: IAlleleBeeEffect

Called by apiaries to cause an effect in the world. (server)

Specified by:

doEffect in interface IAlleleBeeEffect

Overrides:

doEffect in class AlleleEffect

Parameters:

genome - Genome of the bee queen causing this effect

storedData - Object containing the stored effect data for the apiary/hive the bee is in.

housing - IBeeHousing the bee currently resides in.

Returns:

storedData, may have been manipulated.