Package nl.pim16aap2.animatedarchitecture.core.api

Interface IConfig

All Superinterfaces:
IRestartable
All Known Implementing Classes:
ConfigSpigot
public interface IConfig extends IRestartable
Represents the configured settings.

  • Method Details

    • debug

      boolean debug()
      Returns:
      True if debug mode is enabled.

    • isRedstoneEnabled

      boolean isRedstoneEnabled()
      Returns:
      True if redstone is enabled.

    • specificationTimeout

      default int specificationTimeout()
      The amount of time a user gets to specify which structure they meant in case of structureID collisions.

      This can happen in case they specified a structure by its name when they own more than 1 structure with that name.

      Returns:
      The amount of time (in seconds) to give a user to specify which structure they meant.

    • flagMovementFormula

      String flagMovementFormula()
      Returns:
      The movement formula of a flag.

    • coolDown

      int coolDown()
      Gets the number of ticks a structure should wait before it can be activated again.
      Returns:
      The number of ticks a structure should wait before it can be activated again.

    • locale

      Locale locale()

    • maxStructureSize

      OptionalInt maxStructureSize()
      Gets the global maximum number of blocks that can be in a structure.

      Structures exceeding this limit cannot be created or activated.

      Returns:
      The global maximum number of blocks that can be in a structure.

    • cacheTimeout

      int cacheTimeout()
      Gets the amount of time (in minutes) power blocks should be kept in cache.
      Returns:
      The amount of time power blocks should be kept in cache.

    • maxStructureCount

      OptionalInt maxStructureCount()
      Gets the global maximum number of structures a player can own.
      Returns:
      The global maximum number of structures a player can own.

    • maxPowerBlockDistance

      OptionalInt maxPowerBlockDistance()
      Gets the global maximum distance (in blocks) a powerblock can be from the structure.
      Returns:
      The global maximum distance (in blocks) a powerblock can be from the structure.

    • maxBlocksToMove

      OptionalInt maxBlocksToMove()
      Gets the global maximum number of blocks a structure can move for applicable types (e.g. sliding door).
      Returns:
      The global maximum number of blocks a structure can move for applicable types (e.g. sliding door).

    • loadChunksForToggle

      boolean loadChunksForToggle()
      Returns:
      True if we should try to load any unloaded chunks for a toggle.

    • getPrice

      String getPrice(StructureType type)
      Gets the structure price formula for a specific type of structure.
      Parameters:
      type - The structure type.
      Returns:
      The formula for the structure type.

    • getAnimationTimeMultiplier

      double getAnimationTimeMultiplier(StructureType type)
      Gets the animation time multiplier for a specific type of structure.
      Parameters:
      type - The structure type.
      Returns:
      The animation time multiplier for the structure type.

    • maxBlockSpeed

      double maxBlockSpeed()
      Returns:
      The global maximum speed of a block.

    • skipAnimationsByDefault

      boolean skipAnimationsByDefault()
      Whether to skip all animations by default. If true, toggling a structure will simply teleport the blocks to their destination without any animations. For structures that don't have a destination, any toggle request will be ignored.
      Returns:
      True if all animations should be skipped by default.

    • logLevel

      Level logLevel()
      The log level to use.
      Returns:
      The log level.

    • consoleLogging

      boolean consoleLogging()
      Checks if errors should be logged to the console.
      Returns:
      True if errors should be logged to the console.