Package com.djrapitops.plan.extension.annotation

Annotation Interface GroupProvider

@Retention(RUNTIME) @Target(METHOD) public @interface GroupProvider
Method annotation to provide String[] array of Group names about a Player.

This method annotation only works when used with UUID or String as a method parameter (for Players).

For example: @GroupProvider public String[] getJobs(UUID playerUUID) {}

Group data is parsed as Table for /server and /network page and similar to StringProvider for /player page.

Requires Capability DATA_EXTENSION_GROUPS

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Color
    groupColor
    Determine the color of the table header for this group.
    Family
    iconFamily
    Family of Font Awesome icon.
    String
    iconName
    Name of Font Awesome icon.
    String
    text
    Text displayed before the value, limited to 50 characters.

  • Element Details

    • text

      String text
      Text displayed before the value, limited to 50 characters.

      Should inform the user what the group names represent, for example "Town" or "Job"

      Returns:
      String of max 50 characters, remainder will be clipped.
      Default:
      "Group"

    • groupColor

      Color groupColor
      Determine the color of the table header for this group.
      Returns:
      Preferred color. If none are specified defaults are used.
      Default:
      NONE

    • iconName

      String iconName
      Name of Font Awesome icon.

      See https://fontawesome.com/icons (select 'free')) for icons and their Family.

      Returns:
      Name of the icon, if name is not valid no icon is shown.
      Default:
      "circle"

    • iconFamily

      Family iconFamily
      Family of Font Awesome icon.

      See https://fontawesome.com/icons (select 'free')) for icons and their Family.

      Returns:
      Family that matches an icon, if there is no icon for this family no icon is shown.
      Default:
      SOLID