Package org.polyfrost.oneconfig.api.config.v1.annotations

package org.polyfrost.oneconfig.api.config.v1.annotations
  • Annotation Interfaces
    Class
    Description
    Accordion
     
    Button
     
    Checkbox
     
    Color
     
    ColorList
    Renders a user-editable list of colors with each row opening the usual color picker
    DependsOn
    Annotation used to specify conditions for this property
    Apply this annotation to a field or button method
    The value contains an array of strings with each string being the fully qualified path using dots '.' to the condition property
    Any property in the array must be a Boolean

    For complex conditions use
    invalid reference 
    Config#addDependency(String, BooleanSupplier)
    or
    invalid reference 
    Property#addDisplayCondition(BooleanSupplier...)
    DraggableList
    Renders a reorderable list
    Dropdown
     
    EffectList
    Renders a searchable selector for status effects (potion effects)
    File
     
    FileList
    Renders a user-editable list of file (or directory) pickers
    Include
     
    Info
     
    ItemList
    Renders a searchable selector for Minecraft items
    Keybind
     
    MasterToggle
    Makes a boolean field the switch that turns the whole mod on and off
    The mod's card shows the switch.
    MultiSelectDropdown
    Renders a dropdown that opens a selectable list
    Number
     
    NumberList
    Renders a user-editable list of numbers with each row being a number input with stepper arrows
    Option
     
    PreviousNames
    Annotation used to specify previous names that this option was called before so that when the user updates their mod their config will be kept intact
    The format is {"oldCategory.oldSubcategory.oldName1", "oldCategory.oldName2", ...}
    Just putting the old name will **NOT** work
    You must specify the old category and subcategory (if applicable) as well
    RadioButton
     
    RangeNumber
    A start and end pair within RangeNumber.min() and RangeNumber.max() edited with two number inputs
    This is RangeSlider without the track so it suits ranges too wide to drag across
    The annotated field holds both ends together as a two-element numeric array or list such as float[] or int[] or List<Integer> where index 0 is the start and index 1 is the end
    Values are written back in whatever container shape the field already holds so its type is preserved
    RangeNumberList
    Renders a user-editable list of ranges with each row being a pair of number inputs
    RangeSlider
    A slider with two handles selecting a start and end pair within RangeSlider.min() and RangeSlider.max()
    The annotated field holds both ends together as a two-element numeric array or list such as float[] or int[] or List<Integer> where index 0 is the start and index 1 is the end
    Values are written back in whatever container shape the field already holds so its type is preserved
    RangeSliderList
    Renders a user-editable list of ranges with each row being a two-handle slider with a value field for each end
    Slider
     
    SliderList
    Renders a user-editable list of numbers with each row being a slider with a value field beside it
    Switch
     
    Text
     
    TextList
    Renders a user-editable list of text inputs
    TranslatedDefault