Package megamek.server.scriptedEvents

Interface NarrativeDisplayProvider

All Known Implementing Classes:
GameScriptedMessageEvent
public interface NarrativeDisplayProvider
This interface is implemented by scripted event objects that show a story or informative messages in a dialog. This is meant to give a common interface to MHQ's story arc NarrativeStoryPoint as well as scripted event messages in MM so that both can be displayed using a common dialog.

  • Method Details

    • header

      String header()
      Returns:
      A header text to show in the dialog. May be empty but not null.

    • text

      String text()
      Returns:
      The main narrative (story) text to show in the dialog. May be empty but not null.

    • portrait

      @Nullable Image portrait()
      Returns:
      A portrait or other image to show in the dialog

    • splashImage

      @Nullable Image splashImage()
      Returns:
      A splash image to show as part of the story