Package me.hackware.api.setting

Class Setting<T>

java.lang.Object
me.hackware.api.setting.Setting<T>
Direct Known Subclasses:
ActionSetting, BooleanSetting, ChoiceSetting, ColorSetting, FilterSetting, KeybindSetting, ListSetting, MapSetting, MultiSelectSetting, NumberSetting, StringSetting
public abstract class Setting<T> extends Object

  • Field Details

    • value

      protected T value

  • Constructor Details

    • Setting

      protected Setting(String name)

    • Setting

      protected Setting(String name, String description)

    • Setting

      protected Setting(String name, T defaultValue)

    • Setting

      protected Setting(String name, String description, T defaultValue)

  • Method Details

    • setBulkLoadProbe

      public static void setBulkLoadProbe(BooleanSupplier probe)
      Installed once by the config layer; the API ships a never-loading default.

    • isBulkLoading

      public static boolean isBulkLoading()
      True while the config layer is bulk-applying values from disk.

    • displayName

      public Setting<T> displayName(String displayName)

    • description

      public Setting<T> description(String description)

    • group

      public Setting<T> group(String group)

    • defaultValue

      public Setting<T> defaultValue(T defaultValue)

    • visible

      public Setting<T> visible(boolean visible)

    • visible

      public Setting<T> visible(BooleanSupplier visible)

    • onChanged

      public Setting<T> onChanged(Runnable callback)

    • getName

      public String getName()

    • getDisplayName

      public String getDisplayName()

    • getDescription

      public String getDescription()

    • getGroup

      public String getGroup()

    • getDefaultValue

      public T getDefaultValue()

    • get

      public T get()

    • isVisible

      public boolean isVisible()

    • isModal

      public boolean isModal()
      Whether the GUI opens this setting's picker / dropdown / list in a popup instead of inline. See ModalSetting.

    • setModal

      public void setModal(boolean modal)

    • setValue

      public void setValue(T value)

    • resetToDefault

      public void resetToDefault()
      Puts this setting back the way a fresh install has it. Saves and fires onChanged like any other change. A setting that keeps state beyond its value (a color's on/off and rainbow, a bind's mode, a group's children) extends this.

    • getOwner

      public SettingContainer getOwner()

    • setOwner

      public void setOwner(SettingContainer owner)