Package de.cech12.unlitcampfire.platform.services

Interface IConfigHelper

All Known Implementing Classes:
ForgeConfigHelper
public interface IConfigHelper
Common configuration helper service interface.

  • Field Details

    • CAMPFIRE_LIT_TIME_DEFAULT

      static final int CAMPFIRE_LIT_TIME_DEFAULT
      See Also:

    • CAMPFIRE_LIT_TIME_DESCRIPTION

      static final String CAMPFIRE_LIT_TIME_DESCRIPTION
      See Also:

    • CAMPFIRE_LIT_TIME_MIN

      static final int CAMPFIRE_LIT_TIME_MIN
      See Also:

    • CAMPFIRE_LIT_TIME_MAX

      static final int CAMPFIRE_LIT_TIME_MAX
      See Also:

    • CAMPFIRE_RUN_OUT_INDICATOR_TIME_DEFAULT

      static final int CAMPFIRE_RUN_OUT_INDICATOR_TIME_DEFAULT
      See Also:

    • CAMPFIRE_RUN_OUT_INDICATOR_TIME_DESCRIPTION

      static final String CAMPFIRE_RUN_OUT_INDICATOR_TIME_DESCRIPTION
      See Also:

    • CAMPFIRE_RUN_OUT_INDICATOR_TIME_MIN

      static final int CAMPFIRE_RUN_OUT_INDICATOR_TIME_MIN
      See Also:

    • CAMPFIRE_RUN_OUT_INDICATOR_TIME_MAX

      static final int CAMPFIRE_RUN_OUT_INDICATOR_TIME_MAX
      See Also:

    • CAMPFIRE_RAIN_UNLIT_TIME_DEFAULT

      static final int CAMPFIRE_RAIN_UNLIT_TIME_DEFAULT
      See Also:

    • CAMPFIRE_RAIN_UNLIT_TIME_DESCRIPTION

      static final String CAMPFIRE_RAIN_UNLIT_TIME_DESCRIPTION
      See Also:

    • CAMPFIRE_RAIN_UNLIT_TIME_MIN

      static final int CAMPFIRE_RAIN_UNLIT_TIME_MIN
      See Also:

    • CAMPFIRE_RAIN_UNLIT_TIME_MAX

      static final int CAMPFIRE_RAIN_UNLIT_TIME_MAX
      See Also:

    • CAMPFIRE_RAIN_PARTICLE_FACTOR_DEFAULT

      static final int CAMPFIRE_RAIN_PARTICLE_FACTOR_DEFAULT
      See Also:

    • CAMPFIRE_RAIN_PARTICLE_FACTOR_DESCRIPTION

      static final String CAMPFIRE_RAIN_PARTICLE_FACTOR_DESCRIPTION
      See Also:

    • CAMPFIRE_RAIN_PARTICLE_FACTOR_MIN

      static final int CAMPFIRE_RAIN_PARTICLE_FACTOR_MIN
      See Also:

    • CAMPFIRE_RAIN_PARTICLE_FACTOR_MAX

      static final int CAMPFIRE_RAIN_PARTICLE_FACTOR_MAX
      See Also:

    • CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DEFAULT

      static final boolean CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DEFAULT
      See Also:

    • CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DESCRIPTION

      static final String CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DESCRIPTION
      See Also:

    • CAMPFIRE_ADDING_BURNABLES_DEFAULT

      static final boolean CAMPFIRE_ADDING_BURNABLES_DEFAULT
      See Also:

    • CAMPFIRE_ADDING_BURNABLES_DESCRIPTION

      static final String CAMPFIRE_ADDING_BURNABLES_DESCRIPTION
      See Also:

    • CAMPFIRE_MAX_LIT_TIME_EXTENSION_DEFAULT

      static final int CAMPFIRE_MAX_LIT_TIME_EXTENSION_DEFAULT
      See Also:

    • CAMPFIRE_MAX_LIT_TIME_EXTENSION_DESCRIPTION

      static final String CAMPFIRE_MAX_LIT_TIME_EXTENSION_DESCRIPTION
      See Also:

    • CAMPFIRE_MAX_LIT_TIME_EXTENSION_MIN

      static final int CAMPFIRE_MAX_LIT_TIME_EXTENSION_MIN
      See Also:

    • CAMPFIRE_MAX_LIT_TIME_EXTENSION_MAX

      static final int CAMPFIRE_MAX_LIT_TIME_EXTENSION_MAX
      See Also:

    • CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DEFAULT

      static final boolean CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DEFAULT
      See Also:

    • CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DESCRIPTION

      static final String CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DESCRIPTION
      See Also:

    • GENERATED_CAMPFIRE_IS_LIT_INFINITELY_DEFAULT

      static final boolean GENERATED_CAMPFIRE_IS_LIT_INFINITELY_DEFAULT
      See Also:

    • GENERATED_CAMPFIRE_IS_LIT_INFINITELY_DESCRIPTION

      static final String GENERATED_CAMPFIRE_IS_LIT_INFINITELY_DESCRIPTION
      See Also:

    • INFINITE_CAMPFIRE_IGNORES_RAIN_DEFAULT

      static final boolean INFINITE_CAMPFIRE_IGNORES_RAIN_DEFAULT
      See Also:

    • INFINITE_CAMPFIRE_IGNORES_RAIN_DESCRIPTION

      static final String INFINITE_CAMPFIRE_IGNORES_RAIN_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_LIT_TIME_DEFAULT

      static final int SOUL_CAMPFIRE_LIT_TIME_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_LIT_TIME_DESCRIPTION

      static final String SOUL_CAMPFIRE_LIT_TIME_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_LIT_TIME_MIN

      static final int SOUL_CAMPFIRE_LIT_TIME_MIN
      See Also:

    • SOUL_CAMPFIRE_LIT_TIME_MAX

      static final int SOUL_CAMPFIRE_LIT_TIME_MAX
      See Also:

    • SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_DEFAULT

      static final int SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_DESCRIPTION

      static final String SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_MIN

      static final int SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_MIN
      See Also:

    • SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_MAX

      static final int SOUL_CAMPFIRE_RUN_OUT_INDICATOR_TIME_MAX
      See Also:

    • SOUL_CAMPFIRE_RAIN_UNLIT_TIME_DEFAULT

      static final int SOUL_CAMPFIRE_RAIN_UNLIT_TIME_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_RAIN_UNLIT_TIME_DESCRIPTION

      static final String SOUL_CAMPFIRE_RAIN_UNLIT_TIME_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_RAIN_UNLIT_TIME_MIN

      static final int SOUL_CAMPFIRE_RAIN_UNLIT_TIME_MIN
      See Also:

    • SOUL_CAMPFIRE_RAIN_UNLIT_TIME_MAX

      static final int SOUL_CAMPFIRE_RAIN_UNLIT_TIME_MAX
      See Also:

    • SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_DEFAULT

      static final int SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_DESCRIPTION

      static final String SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_MIN

      static final int SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_MIN
      See Also:

    • SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_MAX

      static final int SOUL_CAMPFIRE_RAIN_PARTICLE_FACTOR_MAX
      See Also:

    • SOUL_CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DEFAULT

      static final boolean SOUL_CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DESCRIPTION

      static final String SOUL_CAMPFIRE_BREAKS_WHEN_UNLIT_BY_TIME_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_ADDING_BURNABLES_DEFAULT

      static final boolean SOUL_CAMPFIRE_ADDING_BURNABLES_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_ADDING_BURNABLES_DESCRIPTION

      static final String SOUL_CAMPFIRE_ADDING_BURNABLES_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_DEFAULT

      static final int SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_DESCRIPTION

      static final String SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_DESCRIPTION
      See Also:

    • SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_MIN

      static final int SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_MIN
      See Also:

    • SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_MAX

      static final int SOUL_CAMPFIRE_MAX_LIT_TIME_EXTENSION_MAX
      See Also:

    • SOUL_CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DEFAULT

      static final boolean SOUL_CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DEFAULT
      See Also:

    • SOUL_CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DESCRIPTION

      static final String SOUL_CAMPFIRE_AFFECTED_BY_SLEEP_TIME_DESCRIPTION
      See Also:

    • GENERATED_SOUL_CAMPFIRE_IS_LIT_INFINITELY_DEFAULT

      static final boolean GENERATED_SOUL_CAMPFIRE_IS_LIT_INFINITELY_DEFAULT
      See Also:

    • GENERATED_SOUL_CAMPFIRE_IS_LIT_INFINITELY_DESCRIPTION

      static final String GENERATED_SOUL_CAMPFIRE_IS_LIT_INFINITELY_DESCRIPTION
      See Also:

    • INFINITE_SOUL_CAMPFIRE_IGNORES_RAIN_DEFAULT

      static final boolean INFINITE_SOUL_CAMPFIRE_IGNORES_RAIN_DEFAULT
      See Also:

    • INFINITE_SOUL_CAMPFIRE_IGNORES_RAIN_DESCRIPTION

      static final String INFINITE_SOUL_CAMPFIRE_IGNORES_RAIN_DESCRIPTION
      See Also:

  • Method Details

    • init

      void init()
      Initialization method for the Service implementations.

    • getLitTime

      int getLitTime(boolean isSoulCampfire)
      Gets the configured lit time value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured lit time value

    • getRainUnlitTime

      int getRainUnlitTime(boolean isSoulCampfire)
      Gets the configured rain unlit time value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured rain unlit time value

    • getRunOutIndicatorTime

      int getRunOutIndicatorTime(boolean isSoulCampfire)
      Gets the configured "runs out" indicator time value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "runs out" indicator time value

    • getRainParticleFactor

      int getRainParticleFactor(boolean isSoulCampfire)
      Gets the configured rain particle factor value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured rain particle factor value

    • isBreakingWhenUnlitByTime

      boolean isBreakingWhenUnlitByTime(boolean isSoulCampfire)
      Gets the configured "breaks when unlit by time" value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "breaks when unlit by time" value

    • canAddBurnables

      boolean canAddBurnables(boolean isSoulCampfire)
      Gets the configured "adding burnables" value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "adding burnables" value

    • getMaxLitTimeExtension

      int getMaxLitTimeExtension(boolean isSoulCampfire)
      Gets the configured max lit time extension value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured lit time value

    • isAffectedBySleepTime

      boolean isAffectedBySleepTime(boolean isSoulCampfire)
      Gets the configured "affected by sleep time" value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "affected by sleep time" value

    • isGeneratedCampfireLitInfinitely

      boolean isGeneratedCampfireLitInfinitely(boolean isSoulCampfire)
      Gets the configured "generated campfire is lit infinitely" value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "generated campfire is lit infinitely" value

    • isInfiniteCampfireIgnoringRain

      boolean isInfiniteCampfireIgnoringRain(boolean isSoulCampfire)
      Gets the configured "infinite campfire ignores rain" value.
      Parameters:
      isSoulCampfire - parameter which indicates if the campfire or soul campfire value should be returned
      Returns:
      configured "infinite campfire ignores rain" value