Package dev.prozilla.pine.core.state.config

Class Config

java.lang.Object
dev.prozilla.pine.core.state.config.Config
public class Config extends Object
Manages configuration of the application.
See Also:

  • Field Details

    • FPS

      public static final ConfigKey<Integer> FPS

    • ENABLE_DEPTH_RECALCULATION

      public static final ConfigKey<Boolean> ENABLE_DEPTH_RECALCULATION

    • DEFAULT_FONT_PATH

      public static final ConfigKey<String> DEFAULT_FONT_PATH

    • COMPANY_NAME

      public static final ConfigKey<String> COMPANY_NAME

    • APP_NAME

      public static final ConfigKey<String> APP_NAME

    • AUTO_CREATE_DIRECTORIES

      public static final ConfigKey<Boolean> AUTO_CREATE_DIRECTORIES

    • fps

      public final IntConfigOption fps
      Target frames per second. When set to 0, fps is uncapped. Defaults to 120.

    • enableDepthRecalculation

      public final BooleanConfigOption enableDepthRecalculation
      Determines whether depth values will be recalculated when new entities are added to the world. Defaults to true.

    • defaultFontPath

      public final StringConfigOption defaultFontPath
      Default font used to render text elements. Defaults to null.

    • companyName

      public final StringConfigOption companyName
      The name of the company behind the application. Defaults to null.

    • appName

      public final StringConfigOption appName
      The name of the application. Defaults to "Untitled".

    • autoCreateDirectories

      public final BooleanConfigOption autoCreateDirectories
      Enables the automatic creation of directories. Defaults to true.

    • rendering

      public final RenderConfig rendering
      Options related to rendering.

    • logging

      public final LogConfig logging
      Options related to logging.

    • window

      public final WindowConfig window
      Options related to the application window.

    • storage

      public final StorageConfig storage
      Options related to storage.

  • Constructor Details

    • Config

      public Config()

    • Config

      public Config(Application application)

  • Method Details

    • addOption

      public <T> void addOption(ConfigKey<T> key, ConfigOption<T> option) throws IllegalStateException
      Adds a new config option with a given key.
      Type Parameters:
      T - Type of the option
      Parameters:
      key - Key of the config option
      option - Config option
      Throws:
      IllegalStateException - If key is already associated with an option.

    • removeOption

      public void removeOption(ConfigKey<?> key) throws IllegalStateException
      Throws:
      IllegalStateException

    • hasOption

      public boolean hasOption(ConfigKey<?> key)
      Checks whether this config has an option with a given key.
      Parameters:
      key - Key of the option

    • getOption

      public String getOption(String key)

    • getOption

      public <T> T getOption(ConfigKey<T> key)
      Returns the value of an option.
      Type Parameters:
      T - Type of the option
      Parameters:
      key - Key of the config option
      Returns:
      Value of the option associated with key

    • setOption

      public <T> void setOption(String key, T value)

    • setOption

      public <T> void setOption(ConfigKey<T> key, T value) throws IllegalArgumentException
      Sets the value of an option.
      Type Parameters:
      T - Type of the option
      Parameters:
      key - Key of the config option
      value - New value for the option associated with key
      Throws:
      IllegalArgumentException - If the option has a validator that evaluates to false for value.

    • resetOption

      public void resetOption(ConfigKey<?> key)
      Resets an option to its initial value.
      Parameters:
      key - Key of the config option

    • getKeys

      public Collection<ConfigKey<?>> getKeys()

    • getOptions

      public Collection<ConfigOption<?>> getOptions()
      Returns the collection of options in this configuration.

    • copyFrom

      public void copyFrom(Config otherConfig)
      Copies all options from another config.
      Parameters:
      otherConfig - Config to copy from

    • copyFrom

      public void copyFrom(Config otherConfig, Collection<ConfigKey<?>> keys)
      Copies all options from another config based on a collection of keys.
      Parameters:
      otherConfig - The config to copy from
      keys - The keys of the options to copy

    • copyFrom

      public <T> void copyFrom(Config otherConfig, ConfigKey<T> key)
      Copies an option with a given key from another config.
      Parameters:
      otherConfig - Config to copy from
      key - Key of the option to copy

    • reset

      public void reset()
      Resets all config options to their initial values.