nl.tudelft.goal.unreal.messages
Enum Key

java.lang.Object
  java.lang.Enum<Key>
      nl.tudelft.goal.unreal.messages.Key

All Implemented Interfaces:

Serializable, Comparable<Key>

public enum Key
extends Enum<Key>

List of valid parameter keys that can be used to initialize the environment.

Author:

M.P. Korstanje

Enum Constant Summary

BOTNAMES
List of names for bots.

BOTSERVER
Address of the unreal server.

CONTROLSERVER
Address of the control server.

CONTROLSERVERNAME
Name used by the server.

LEADTARGET
Weather or not the bot aims ahead of the target.

LOGLEVEL
Log level used.

SKILL
Skill of the bot between 0 (poor) and 7 (good).

SKIN
Skin used by the bot.

STARTLOCATION
Start location for the bot.

STARTROTATION
Start rotation for the bot.

TEAM
Team of the bot.

VISUALIZERSERVER
Address for the visualizer service.

Method Summary

Object	getKey()
static Key	parseKey(String value) Returns the enum with the value of the string.
String	toString()
static Key	valueOf(String name) Returns the enum constant of this type with the specified name.
static Key[]	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

BOTNAMES

public static final Key BOTNAMES

List of names for bots. The number of names provided matches the number of bots launched by the environment.

CONTROLSERVER

public static final Key CONTROLSERVER

Address of the control server. Should be of the form protocol//host:port

LEADTARGET

public static final Key LEADTARGET

Weather or not the bot aims ahead of the target. Either "true" of "false".

LOGLEVEL

public static final Key LOGLEVEL

Log level used. Controls how many messages are displayed on the console. Valid log levels are any from Level.

BOTSERVER

public static final Key BOTSERVER

Address of the unreal server. Should be of the form protocol//host:port

CONTROLSERVERNAME

public static final Key CONTROLSERVERNAME

Name used by the server. Any string.

SKILL

public static final Key SKILL

Skill of the bot between 0 (poor) and 7 (good). Controls how well the bot aims.

SKIN

public static final Key SKIN

Skin used by the bot. Any one of Skin will do.

TEAM

public static final Key TEAM

Team of the bot. Either 0 (red) or 1 (blue).

VISUALIZERSERVER

public static final Key VISUALIZERSERVER

Address for the visualizer service.

STARTLOCATION

public static final Key STARTLOCATION

Start location for the bot.

STARTROTATION

public static final Key STARTROTATION

Start rotation for the bot.

Method Detail

values

public static Key[] 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 (Key c : Key.values())
    System.out.println(c);

Returns:

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

valueOf

public static Key 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()

Overrides:

toString in class Enum<Key>

Returns:

a human readable name.

parseKey

public static Key parseKey(String value)
                    throws IllegalArgumentException

Returns the enum with the value of the string. matches.

Parameters:

value -

Returns:

an ParameterKey.

Throws:

IllegalArgumentException - if the provided value was not a valid parameter key.

getKey

public Object getKey()