Package net.storm.api.plugins.config

Interface ConfigObject

All Known Implementing Classes:
ConfigItemDescriptor, ConfigSectionDescriptor, ConfigTitleDescriptor
public interface ConfigObject
Common interface for configuration descriptor objects.

ConfigObject provides a unified interface for all configuration elements (sections, titles, and items) that can be displayed in the configuration panel. This allows them to be sorted and organized consistently.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    key()
    Gets the unique key identifying this configuration object.
    String
    name()
    Gets the display name of this configuration object.
    int
    position()
    Gets the display position of this configuration object.

  • Method Details

    • key

      String key()
      Gets the unique key identifying this configuration object.

      For sections and titles, this is typically the field name. For items, this is the keyName from the ConfigItem annotation.

      Returns:
      the unique identifier key

    • name

      String name()
      Gets the display name of this configuration object.

      This is the human-readable name shown in the configuration panel.

      Returns:
      the display name

    • position

      int position()
      Gets the display position of this configuration object.

      Objects are sorted by position in ascending order when rendering the configuration panel.

      Returns:
      the position value for sorting