Package journeymap.api.v2.client.option

Class Option<T>

java.lang.Object
journeymap.api.v2.client.option.Option<T>
Direct Known Subclasses:
BooleanOption, CustomOption, EnumOption, FloatOption, IntegerOption
@Deprecated(forRemoval=true) public abstract class Option<T> extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Use Option instead. Scheduled for removal in JourneyMap for Minecraft 26.2.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Config<T>
    config
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected final T
    defaultValue
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Option(OptionCategory category, String fieldName, String label, T defaultValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Parent for all options.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    get()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    OptionCategory
    getCategory()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    T
    getDefaultValue()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getFieldName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getLabel()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getSortOrder()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    set(T value)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Option<T>
    setSortOrder(int sortOrder)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Used for sorting in the options pane.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • defaultValue

      protected final T defaultValue
      Deprecated, for removal: This API element is subject to removal in a future version.

    • config

      protected Config<T> config
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • Option

      protected Option(OptionCategory category, String fieldName, String label, T defaultValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parent for all options. For tooltips, your i18n key plus .tooltip in your language json example mod.option.label and mod.option.label.tooltip
      Parameters:
      category - - The category.
      fieldName - - The field name.
      label - - the label, can be the display string or i18n key.
      defaultValue - - the default value.

  • Method Details

    • getCategory

      public OptionCategory getCategory()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getFieldName

      public String getFieldName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getLabel

      public String getLabel()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • get

      public T get()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • set

      public void set(T value)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getDefaultValue

      public T getDefaultValue()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSortOrder

      public int getSortOrder()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSortOrder

      public Option<T> setSortOrder(int sortOrder)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Used for sorting in the options pane.
      Parameters:
      sortOrder - the sort order.