Package name.moore.kevin.ze.game.events

Enum gameEvent.REASON

java.lang.Object
java.lang.Enum<gameEvent.REASON>
name.moore.kevin.ze.game.events.gameEvent.REASON
All Implemented Interfaces:
Serializable, Comparable<gameEvent.REASON>, java.lang.constant.Constable
Enclosing class:
gameEvent
public static enum gameEvent.REASON extends Enum<gameEvent.REASON>
List of REASONs for the event, the source should be able to provide the associated data if required.

  • Enum Constant Details

    • NULL

      public static final gameEvent.REASON NULL
      No reason at all, NOP.

    • TEST

      public static final gameEvent.REASON TEST
      Testing purposes, NOP.

    • TRACE

      public static final gameEvent.REASON TRACE
      Output an appropriate trace level logging. Good for testing.

    • STARDATE

      public static final gameEvent.REASON STARDATE
      The game clock has changed.
      • primary = unused, set to NULL_ID
      • secondary = unused
      • date = new stardate

    • ARRIVED

      public static final gameEvent.REASON ARRIVED
      Notification that a planned journey has been completed. event source = EventId of what was travelling.

    • DEPART

      public static final gameEvent.REASON DEPART
      Instruction to leave orbit and travel towards a destination.
      • primary = EntityId of ship
      • secondary = EntityId of destination planet

    • COMPLETED

      public static final gameEvent.REASON COMPLETED
      Construction of something has been completed.
      • primary = EntityId of builder (eg planet, shipyard, industry)
      • secondary = unused

    • FINALISE

      public static final gameEvent.REASON FINALISE

    • CONSTRUCT

      public static final gameEvent.REASON CONSTRUCT
      Initiate construction of something.
      • primary = EntityId of spec to be built.
      • secondary = EntityId of planet where building occurs

    • INSTALL

      public static final gameEvent.REASON INSTALL

    • REPAIRED

      public static final gameEvent.REASON REPAIRED
      A repair was completed on an item. Expects a piece object as the source

    • VIOLENCE

      public static final gameEvent.REASON VIOLENCE
      Violence was initiated, recheck diplomatic affiliations. This is only posted at -initiation- rather than on every shot.

    • ENGAGE

      public static final gameEvent.REASON ENGAGE
      Target and attack specified entity as best possible. Other things may be attacked in passing, but this is considered the attackers objective.
      • primary = EntityId of attacker (a ship)
      • secondary = EntityId of target.

    • DISENGAGE

      public static final gameEvent.REASON DISENGAGE
      Cease aggressive attacks and attempt place itself out of combat. The ship may well continue firing but its goal will be to escape combat.
      • primary = EntityId of attacker (a ship)
      • secondary = unused.

    • FINANCE

      public static final gameEvent.REASON FINANCE
      Change in a factions finances. The source object is the faction which is then used to get the bank balance.

  • Constructor Details

    • REASON

      private REASON()

  • Method Details

    • values

      public static gameEvent.REASON[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static gameEvent.REASON valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null