Interface ModDisplayInfo

All Superinterfaces:
IExtensionPoint
All Known Implementing Classes:
BlankModDisplayInfo, DefaultModDisplayInfo
public interface ModDisplayInfo extends IExtensionPoint

An extension point for information displayed on the mod list screen.

Unless otherwise stated in the documentation, provided components may contain click actions and hover actions.

See Also:

  • Method Details

    • id

      String id()
      Returns the mod ID. This is used to retrieve the mod container, configuration screen extension point, and other relevant information.
      Returns:
      the mod ID

    • displayName

      Component displayName()
      Returns the display name. This is always displayed, even if empty. Click actions do not work on this component.
      Returns:
      the display name

    • version

      String version()
      Returns the mod version. This is always displayed, even if empty.
      Returns:
      the mod version

    • authors

      Component authors()
      Returns the mod authors. This is displayed if it is not an empty component.
      Returns:
      the mod authors

    • credits

      Component credits()
      Returns the credits. This is displayed if it is not an empty component.
      Returns:
      the credits

    • description

      Component description()
      Returns the mod description. This is displayed if it is not an empty component.
      Returns:
      the mod description

    • license

      Component license()
      Returns the mod license. This is always displayed, even if empty.
      Returns:
      the mod license

    • banner

      @Nullable ImageResource banner()

      Returns the banner displayed in the info panel, or null.

      The banner is rendered with its original aspect ratio, bounded by the width of the info panel (ordinarily 250 pixels) and a maximum height of 50 pixels.

      Returns:
      the banner displayed in the info panel, or null

    • icon

      @Nullable ImageResource icon()

      Returns the icon displayed in the mod list, or null.

      The icon is rendered as a square with sides of 24 pixels.

      Returns:
      the icon displayed in the mod list, or null

    • iconBlur

      default boolean iconBlur()
      Returns whether linear filtering should be used when scaling the icon.
      Returns:
      whether linear filtering should be used when scaling the icon

    • displayUrl

      @Nullable URI displayUrl()
      Returns the URL for the mod homepage, or null. If null, the homepage button is disabled.
      Returns:
      the URL for the mod homepage, or null

    • issuesUrl

      @Nullable URI issuesUrl()
      Returns the URL for the mod issues page, or null. If null, the issues page button is disabled.
      Returns:
      the URL for the mod issues page, or null