Package megamek.server.scriptedEvents

Class MessageTriggeredActiveEvent

java.lang.Object

megamek.server.scriptedEvents.MessageTriggeredActiveEvent

All Implemented Interfaces:

TriggeredActiveEvent, TriggeredEvent

public class MessageTriggeredActiveEvent
extends Object
implements TriggeredActiveEvent

Constructor Summary

Constructors

Constructor	Description
MessageTriggeredActiveEvent(Trigger trigger, String header, String message)	Deprecated, for removal: This API element is subject to removal in a future version.
MessageTriggeredActiveEvent(Trigger trigger, String header, String message, Image image)

Method Summary

Modifier and Type	Method	Description
void	process(IGameManager gameManager)	This method is called when the Trigger of this event is satisfied (returns true).
String	toString()
Trigger	trigger()

Methods inherited from class java.lang.Object

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

Methods inherited from interface megamek.server.scriptedEvents.TriggeredEvent

isGameEnding

Constructor Details

MessageTriggeredActiveEvent

public MessageTriggeredActiveEvent(Trigger trigger,
 String header,
 String message,
 @Nullable
 Image image)

MessageTriggeredActiveEvent

@Deprecated(since="0.51.0",
            forRemoval=true)
public MessageTriggeredActiveEvent(Trigger trigger,
 String header,
 String message)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

trigger

public Trigger trigger()

Specified by:

trigger in interface TriggeredEvent

Returns:

The Trigger that controls when this event happens. Note that it is up to the Trigger to control if this event may happen multiple times. A subclass of AbstractOneTimeTrigger or a OnceTrigger can be used to define a trigger that will never happen more than once.

process

public void process(IGameManager gameManager)

Description copied from interface: TriggeredActiveEvent

This method is called when the Trigger of this event is satisfied (returns true). This method must fully work out whatever the event brings, including sending the necessary packets. The code of this method is essentially part of the GameManager's code.

Specified by:

process in interface TriggeredActiveEvent

toString

public String toString()

Overrides:

toString in class Object