Package megamek.server.scriptedEvents

Interface TriggeredEvent

All Known Subinterfaces:
TriggeredActiveEvent
All Known Implementing Classes:
DrawTriggeredEvent, GameEndTriggeredEvent, MessageTriggeredActiveEvent, PrincessSettingsEvent, VictoryTriggeredEvent
public interface TriggeredEvent
This interface is implemented by pre-determined events that may happen over the course of a game, such as game end or victory that do not change the game status but only examine it. These events are based on a Trigger that defines when (and how often) they happen. (Note: This has nothing to do with an event listener system.)

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isGameEnding()
     
    Trigger
    trigger()
     

  • Method Details

    • trigger

      Trigger trigger()
      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.

    • isGameEnding

      default boolean isGameEnding()