cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class HelloBotHandshake

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.HelloBotHandshake

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class HelloBotHandshake
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event HELLO_BOT.

Complete message documentation: Asynchronous message. Sent for bot connection. First message from UT2004, part of handshake.

Field Summary

protected String	Game Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected boolean	ServerFull If it is true, connection will be terminated afterwards.
protected long	SimTime
protected String	Version Version number of GameBots.

Constructor Summary

HelloBotHandshake()
Parameter-less contructor for the message.

HelloBotHandshake(boolean ServerFull, String Game, String Version)
Creates new instance of the message HelloBotHandshake.

HelloBotHandshake(HelloBotHandshake original)
Cloning constructor from the full message.

Method Summary

String	getGame() Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).
long	getSimTime() Simulation time in MILLI SECONDS !!!
String	getVersion() Version number of GameBots.
boolean	isServerFull() If it is true, connection will be terminated afterwards.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toJsonLiteral()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROTOTYPE

public static final String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

SimTime

protected long SimTime

ServerFull

protected boolean ServerFull

If it is true, connection will be terminated afterwards.

Game

protected String Game

Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).

Version

protected String Version

Version number of GameBots.

Constructor Detail

HelloBotHandshake

public HelloBotHandshake()

Parameter-less contructor for the message.

HelloBotHandshake

public HelloBotHandshake(boolean ServerFull,
                         String Game,
                         String Version)

Creates new instance of the message HelloBotHandshake. Asynchronous message. Sent for bot connection. First message from UT2004, part of handshake. Corresponding GameBots message is HELLO_BOT.

Parameters:

ServerFull - If it is true, connection will be terminated afterwards.

Game - Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).

Version - Version number of GameBots.

HelloBotHandshake

public HelloBotHandshake(HelloBotHandshake original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Simulation time in MILLI SECONDS !!!

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

setSimTime

protected void setSimTime(long SimTime)

Used by Yylex to slip correct time of the object or programmatically.

isServerFull

public boolean isServerFull()

If it is true, connection will be terminated afterwards.

getGame

public String getGame()

Name of the Unreal Tournament version these GameBots are running on (UT2004, UE2, UDK, UT3...).

getVersion

public String getVersion()

Version number of GameBots.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage