Package appeng.api.util

Interface IConfigManager

public interface IConfigManager
Used to adjust settings on an object,

Obtained via IConfigurableObject

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends Enum<T>>
    T
    getSetting(Setting<T> setting)
    Get Value of a particular setting
    Set<Setting<?>>
    getSettings()
    get a list of different settings
    default boolean
    hasSetting(Setting<?> setting)
    Checks if this config manager supports the given setting.
    <T extends Enum<T>>
    void
    putSetting(Setting<T> setting, T newValue)
    Change setting
    boolean
    readFromNBT(net.minecraft.nbt.CompoundTag src)
    Only works after settings have been registered
    <T extends Enum<T>>
    void
    registerSetting(Setting<T> setting, T defaultValue)
    used to initialize the configuration manager, should be called for all settings.
    void
    writeToNBT(net.minecraft.nbt.CompoundTag destination)
    write all settings to the NBT Tag so they can be read later.

  • Method Details

    • getSettings

      Set<Setting<?>> getSettings()
      get a list of different settings
      Returns:
      enum set of settings

    • hasSetting

      default boolean hasSetting(Setting<?> setting)
      Checks if this config manager supports the given setting.

    • registerSetting

      <T extends Enum<T>> void registerSetting(Setting<T> setting, T defaultValue)
      used to initialize the configuration manager, should be called for all settings.
      Parameters:
      setting - the setting
      defaultValue - default value of setting

    • getSetting

      <T extends Enum<T>> T getSetting(Setting<T> setting)
      Get Value of a particular setting
      Parameters:
      setting - the setting
      Returns:
      value of setting
      Throws:
      UnsupportedSettingException - if setting has not been registered before

    • putSetting

      <T extends Enum<T>> void putSetting(Setting<T> setting, T newValue)
      Change setting
      Parameters:
      setting - to be changed setting
      newValue - new value for setting
      Throws:
      UnsupportedSettingException - if setting has not been registered before

    • writeToNBT

      void writeToNBT(net.minecraft.nbt.CompoundTag destination)
      write all settings to the NBT Tag so they can be read later.
      Parameters:
      destination - to be written nbt tag

    • readFromNBT

      boolean readFromNBT(net.minecraft.nbt.CompoundTag src)
      Only works after settings have been registered
      Parameters:
      src - to be read nbt tag
      Returns:
      true if any configuration was loaded from src