Package cz.cuni.pogamut.MessageObjects

Java wrappers for the message objects send by the GameBots2004.

See:
Description

Interface Summary

Located	Interface for all message objects that are connected to some place.
Visible	Interface for message objects whose visibility may change in the time.

Class Summary

AddAmmo	AddAmmo has ammoAmount and weapon type, it is processed in inventory according to those variables (adds proper amount of ammo to proper weapon)
AddArmor	Picked up armor has only strenght and type in addition
AddExtra	AddExtra is a class for user-defined inventory in the game like mushrooms, apples, mines, whatever is a user fantasy it is basicaly same as Item, the only advantage of this class is that anyone can register listener exactly for Extra messages
AddHealth	AddHealth has three extra variables: type - e. g.
AddItem	Added inventory.
AddSpecial	AddSpecial covers things like Adrenaline, it has no other extra variables
AddWeapon	AddWeapon is representing a weapon agent is carrying.
AdrenalineGained
AliveMessage	Alive message are for measuring the server lag.
Ammo	Ammo is a class that represents ammo - has special property Ammo type, which is derived from UnrealID and typesOfAmmo
Armor	Armor is derived from Item, it has additional variables type of armor and strenght
AutoTraceRay	AutoTraceRay notification message contains: ID: id of the ray query from: location from which the ray is emitted to: location to which the ray is sended result: true if it hit something, false if not hitNormal: normal vector to the trace ray in the point of hit hitId: id of hitted actor hitLocation: point of the hit traceActors: whether to care about other actors in the game fastTrace: switch to fastTrace way of evaluation of trace synchronous message - sended every turn NOTE that it is not delta compressed
BeginMessage	Begin message signaliza start of synchronous batch.
BotDamaged	This bot has been damaged.
BotKilled	This bot has died.
Bumped	Bot bumped into another actor
Command	Command is a wrapper for string which contain command content and command type (e. g.
ConfigChange
DeleteFromBatch	This message is sent whenever anything from current batch has to be removed.
Disconnected	This message will be send, when gamebot disconnects.
DominationPoint	Domination point contains following important properties: controller - number of the team which controls the point location
DummyMessage	Dummy message, UTServerConnection is using it ... ...
EndMessage	This message signalize end of synchronous batch of informations
Extra	Extra is a class for user-defined inventory in the game like mushrooms, apples, mines, whatever is a user fantasy it is basicaly same as Item, the only advantage of this class is that anyone can register listener exactly for Extra messages
FallEdge	This class represents case, where bot stands at the edge of cliff or somewhere the bot can fall.
FastTrace	Trace notification message contains: ID: id of the trace query from: location from which the ray is emitted to: location to which the ray is sended result: true if it hit something, false if not asynchronous message
FlagInfo	FlagInfo contains all info about the flag in the CTF game mode id - a unique id for this flag, assigned by the game location - an absolute location of the flag holder - the identity of player/bot holding the flag (only sent if flag is being carried).
GameInfo	Information about starting game.
GamePaused
GameResumed
GameStatus	GameStatus contains information about teams and players scores, which are stored in two hashmaps
GlobalChat	Recieved message from global chat channel
Health	Health contains those properties: Strenght - 5 for HealthVials, 25 for MedKits Boostable - true for HealthVials - agent health can exceed 100 points TypeOfHealth - HealthVial | MedKit
HearNoise	Hear noise.
HearPickup	Hear pickup.
HelloBotHandshake	First message from UT2004, part of handshake.
HelloControlServerHandshake
HelloMap
ChangedWeapon	Bot changed weapons.
IncommingProjectile	Incoming projectile likely to hit you.
Item	An object on the ground that can be picked up.
ItemCathegories	this class is a database, yet it could be written in XML, but we decided to save parsing of XML and do it this way anyway, this class stores static HashMap, that includes all known objects in current Unreal Tournament 2004 the key is the object class, atributes are desribing object properties, capabilities etc.
ItemCathegory	ItemCathegory object contains additional information about item it is initialized according to information stored in ItemCathegories it has couple different consturctors depending on the number of parameters - atributes of the current types of objects so every object has message type identifies type of message (WEAPON, AMMO etc.)
ItemList	start / end of list of items which is sent at the beginning of the connection to GB
MapFinished	when the end of the simulation - ergo game, ergo map - is close, this message is sent, so agents can disconnect
MapChange
MapListEnd	End of list of maps
MapListStart	Start of the map list - list of all maps available on the server - needed by server control to offer options like choose map
MessageObject	MessageObject serves as a parent of all messages passed from GB to agent.
Mover	A "mover".
NavList	Start and end of navigation list which is sent at the beginning of the communication
NavPoint	NavPoint carries information about Unreal NavPoint - location, reachability, its neighbours and in case it is respawn point, class of item that respawn.
NeighNav
Path	Path is an object to store information from Gamebots message PATH it contains an array of navPoints that leads to the goal point PATHs are stored in GameMap
Player	Contains information about other players in the game, like their current velocity, position, weapon and rechablity Another character (bot or human) in the game.
PlayerDamaged	Bot hurt another player.
PlayerJoinsGame
PlayerKilled	Some other player died - report from his death
PlayerLeft
PlayerListEnd
PlayerListStart
Pong
RayList
Reachable	A boolean result of a checkreach call.
SeePlayer	See player.
Self	Information about your bot's state.
Spawn	notification message about the bot spawn action
Special	Special is for Adrenaline and Damage amplifier
SynchronousMessages	Set of synchronous messages Used when copying history batch - copies only synchronous messages - other are events
TeamChat	Recieved message from team chat channel
Thrown
Trace	Trace notification message contains: ID: id of the trace query from: location from which the ray is emitted to: location to which the ray is sended result: true if it hit something, false if not hitNormal: normal vector to the trace ray in the point of hit hitId: id of hitted actor hitLocation: point of the hit asynchronous message
Triple	Triple implemets triple of double - used in representation of location, rotation, velocity Triple has couple handy methods like add, substract, distance (in 2D and in 3D) which are usefull while designing agent in complex virtual environment
UTMap
WallCollision	Collided with a wall.
Weapon	Weapon is representing a weapon agent sees.
ZoneChangedBot	Bot changed zones.
ZoneChangedFoot	Foot changed zones.
ZoneChangedHead	Head changed zones.

Enum Summary

CommandTypes	enum of all available commands (command types)
ItemType	enum of all known item types, extra types must be processed separately
MessageGroup
MessageType	Enum of all message types available
NeighNavFlag	This is enum for edge flag between navpoints.

Package cz.cuni.pogamut.MessageObjects Description

Java wrappers for the message objects send by the GameBots2004.