Package megamek.common.event

Class GameScriptedMessageEvent

java.lang.Object

java.util.EventObject

megamek.common.event.GameEvent

megamek.common.event.GameScriptedEvent

megamek.common.event.GameScriptedMessageEvent

All Implemented Interfaces:

Serializable, NarrativeDisplayProvider

public class GameScriptedMessageEvent
extends GameScriptedEvent
implements NarrativeDisplayProvider

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
GameScriptedMessageEvent(Object source, String header, String message, Base64Image image)

Method Summary

Modifier and Type	Method	Description
String	header()
String	message()
Image	portrait()
Image	splashImage()
String	text()

Methods inherited from class megamek.common.event.GameScriptedEvent

fireEvent, getEventName

Methods inherited from class megamek.common.event.GameEvent

toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Details

GameScriptedMessageEvent

public GameScriptedMessageEvent(Object source,
 String header,
 String message,
 @Nullable
 Base64Image image)

Method Details

message

public String message()

header

public String header()

Specified by:

header in interface NarrativeDisplayProvider

Returns:

A header text to show in the dialog. May be empty but not null.

text

public String text()

Specified by:

text in interface NarrativeDisplayProvider

Returns:

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

portrait

public Image portrait()

Specified by:

portrait in interface NarrativeDisplayProvider

Returns:

A portrait or other image to show in the dialog

splashImage

public Image splashImage()

Specified by:

splashImage in interface NarrativeDisplayProvider

Returns:

A splash image to show as part of the story