Package fr.r1r0r0.deltaengine.model.events

Class Event

java.lang.Object
fr.r1r0r0.deltaengine.model.events.Event
Direct Known Subclasses:
VoidEvent
public abstract class Event
extends java.lang.Object
An event. Contain triggers who can be triggered when predefined conditions are met by checkEvent method. If trigger method is called, all triggered contained will be activated. (Implements Observer pattern)

  • Field Summary

    Fields
    Modifier and Type Field Description
    private java.util.List<Trigger> triggers  

  • Constructor Summary

    Constructors
    Constructor Description
    Event()
    Default constructor

  • Method Summary

    Modifier and Type Method Description
    void addTrigger​(Trigger trigger)
    Add a trigger to the event
    abstract void checkEvent()
    Called by the engine, all code of the event.
    void clearTriggers()
    Clear all triggers registered to this event
    boolean removeTrigger​(Trigger trigger)
    Remove a trigger from the event
    void runTriggers()
    When called, call all triggers and run their code

    Methods inherited from class java.lang.Object

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

  • Field Details

    • triggers

      private final java.util.List<Trigger> triggers

  • Constructor Details

    • Event

      public Event()
      Default constructor

  • Method Details

    • addTrigger

      public final void addTrigger​(Trigger trigger)
      Add a trigger to the event
      Parameters:
      trigger - trigger to add

    • removeTrigger

      public final boolean removeTrigger​(Trigger trigger)
      Remove a trigger from the event
      Parameters:
      trigger - trigger to remove
      Returns:
      true if trigger has been removed successfully, false otherwise

    • clearTriggers

      public final void clearTriggers()
      Clear all triggers registered to this event

    • runTriggers

      public final void runTriggers()
      When called, call all triggers and run their code

    • checkEvent

      public abstract void checkEvent()
      Called by the engine, all code of the event. Everything can be implemented here.
      To activate all attached triggers, runTriggers() method from Event object must be called.
      See Also:
      to run all registered triggers