Package megamek.common.event

Class GameToastEvent

java.lang.Object

java.util.EventObject

megamek.common.event.GameEvent

megamek.common.event.GameToastEvent

All Implemented Interfaces:

Serializable

public class GameToastEvent
extends GameEvent

A game event raised when the server wants the client to show a transient toast notification on the board view - for example, "Fortification complete" when Trench/Fieldworks Engineers finish a fortified hex.

The severity is expressed with the layer-neutral GameToastEvent.Level enum so that this common event carries no dependency on the client UI's toast rendering type; the client maps GameToastEvent.Level to its own toast styling when it shows the message.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GameToastEvent.Level	Layer-neutral severity for a toast, mirrored by the client UI's own toast styling.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
GameToastEvent(Object source, GameToastEvent.Level level, String message, int entityId)

Method Summary

Modifier and Type	Method	Description
int	entityId()
void	fireEvent(GameListener gl)	Sub-classed events implement this method to call their specific method on a GameListener instance that their event has been fired.
String	getEventName()
GameToastEvent.Level	level()
String	message()

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

GameToastEvent

public GameToastEvent(Object source,
 GameToastEvent.Level level,
 String message,
 int entityId)

Parameters:

source - the event source (usually the client)

level - the severity of the toast

message - the (already localized) text to display

entityId - the id of the acting unit whose icon should accompany the toast, or BTObject.NONE for a text-only toast

Method Details

level

public GameToastEvent.Level level()

message

public String message()

entityId

public int entityId()

fireEvent

public void fireEvent(GameListener gl)

Description copied from class: GameEvent

Sub-classed events implement this method to call their specific method on a GameListener instance that their event has been fired.

Specified by:

fireEvent in class GameEvent

Parameters:

gl - GameListener recipient.

getEventName

public String getEventName()

Specified by:

getEventName in class GameEvent