ForestryMC/src/main/java/forestry/api/apiculture/IBeeModifier.java

/*******************************************************************************
 * Copyright 2011-2014 SirSengir
 *
 * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details.
 ******************************************************************************/
package forestry.api.apiculture;

public interface IBeeModifier {

    /**
     * @param genome          Genome of the bee this modifier is called for.
     * @param currentModifier Current modifier.
     * @return Float used to modify the base territory.
     */
    float getTerritoryModifier(IBeeGenome genome, float currentModifier);

    /**
     * @param genome          Genome of the bee this modifier is called for.
     * @param mate            Genome of the bee mate this modifier is called for.
     * @param currentModifier Current modifier.
     * @return Float used to modify the base mutation chance.
     */
    float getMutationModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier);

    /**
     * @param genome          Genome of the bee this modifier is called for.
     * @param currentModifier Current modifier.
     * @return Float used to modify the life span of queens.
     */
    float getLifespanModifier(IBeeGenome genome, IBeeGenome mate, float currentModifier);

    /**
     * @param genome          Genome of the bee this modifier is called for.
     * @param currentModifier Current modifier.
     * @return Float modifying the production speed of queens.
     */
    float getProductionModifier(IBeeGenome genome, float currentModifier);

    /**
     * @param genome Genome of the bee this modifier is called for.
     * @return Float modifying the flowering of queens.
     */
    float getFloweringModifier(IBeeGenome genome, float currentModifier);

    /**
     * @param genome Genome of the bee this modifier is called for.
     * @return Float modifying the chance for a swarmer queen to die off.
     */
    float getGeneticDecay(IBeeGenome genome, float currentModifier);

    /**
     * @return Boolean indicating if housing can ignore rain
     */
    boolean isSealed();

    /**
     * @return Boolean indicating if housing can ignore darkness/night. Cannot be used together with SelfUnlighted
     */
    boolean isSelfLighted();

    /**
     * @return Boolean indicating if housing can ignore lightness/day. Cannot be used together with SelfLighted
     */
    default boolean isSelfUnlighted() {
        return false;
    }

    /**
     * @return Boolean indicating if housing can ignore not seeing the sky
     */
    boolean isSunlightSimulated();

    /**
     * @return Boolean indicating whether this housing simulates the nether
     */
    boolean isHellish();
}