com.camelspotting.jotl.event
Enum OpenTTDEventType

java.lang.Object
  extended by java.lang.Enum<OpenTTDEventType>
      extended by com.camelspotting.jotl.event.OpenTTDEventType
All Implemented Interfaces:
Serializable, Comparable<OpenTTDEventType>

public enum OpenTTDEventType
extends Enum<OpenTTDEventType>

This enum represents the type of OpenTTD events.

Version:
1.0
Author:
Mats Andreassen

Enum Constant Summary
COMPANY_NEW
          A new company has been created
COMPANY_REMOVED
          A company has been removed
ELECTRIC_AVAILABLE
          Electric rail has now become available
GAME_END
          A game has ended
GAME_IN_PROGRESS
          A game is in progress
GAME_START
          A game has started
LOST_CONNECTION
          Software has lost connection to server
MAGLEV_AVAILABLE
          Maglev has now become available
MONORAIL_AVAILABLE
          Monorail has now become available
NEW_LEADER
          A new company now has the best rating
PAUSED
          The game has been paused
UNPAUSED
          The game has been unpaused
 
Method Summary
 String getDescription()
           
 String toString()
          Returns a textual description of the enum.
static OpenTTDEventType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static OpenTTDEventType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

GAME_END

public static final OpenTTDEventType GAME_END
A game has ended


GAME_START

public static final OpenTTDEventType GAME_START
A game has started


GAME_IN_PROGRESS

public static final OpenTTDEventType GAME_IN_PROGRESS
A game is in progress


NEW_LEADER

public static final OpenTTDEventType NEW_LEADER
A new company now has the best rating


ELECTRIC_AVAILABLE

public static final OpenTTDEventType ELECTRIC_AVAILABLE
Electric rail has now become available


MONORAIL_AVAILABLE

public static final OpenTTDEventType MONORAIL_AVAILABLE
Monorail has now become available


MAGLEV_AVAILABLE

public static final OpenTTDEventType MAGLEV_AVAILABLE
Maglev has now become available


COMPANY_NEW

public static final OpenTTDEventType COMPANY_NEW
A new company has been created


COMPANY_REMOVED

public static final OpenTTDEventType COMPANY_REMOVED
A company has been removed


PAUSED

public static final OpenTTDEventType PAUSED
The game has been paused


UNPAUSED

public static final OpenTTDEventType UNPAUSED
The game has been unpaused


LOST_CONNECTION

public static final OpenTTDEventType LOST_CONNECTION
Software has lost connection to server

Method Detail

values

public static OpenTTDEventType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (OpenTTDEventType c : OpenTTDEventType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static OpenTTDEventType 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

toString

public String toString()
Returns a textual description of the enum.

Overrides:
toString in class Enum<OpenTTDEventType>
Returns:
the description

getDescription

public String getDescription()
Returns:
the description


Copyright © 2013. All Rights Reserved.