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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class ChangedWeapon
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event CWP.

Complete message documentation: Asynchronous message. Bot changed weapon. Possibly as a result of a command sent by you. Here we will get the new weapon - the weapon the bot has changed to.

Field Summary

protected java.lang.String	Id Unique Id of new weapon, based on the inventory weapon's name (this is different from the Id of the weapon that can be picked up in the map).
protected int	PrimaryAmmo Holding current primary ammo of the new weapon.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected int	SecondaryAmmo Holding current secondary ammo of the new weapon.
protected long	SimTime
protected java.lang.String	Type A string representing the type of the weapon.

Constructor Summary

ChangedWeapon()
Parameter-less contructor for the message.

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

ChangedWeapon(java.lang.String Id, int PrimaryAmmo, int SecondaryAmmo, java.lang.String Type)
Creates new instance of the message ChangedWeapon.

Method Summary

java.lang.String	getId() Unique Id of new weapon, based on the inventory weapon's name (this is different from the Id of the weapon that can be picked up in the map).
int	getPrimaryAmmo() Holding current primary ammo of the new weapon.
int	getSecondaryAmmo() Holding current secondary ammo of the new weapon.
long	getSimTime() Returns the simulation time when the event has occurred.
java.lang.String	getType() A string representing the type of the weapon.
protected void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
java.lang.String	toHtmlString()
java.lang.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 java.lang.String PROTOTYPE

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

See Also:

Constant Field Values

SimTime

protected long SimTime

Id

protected java.lang.String Id

Unique Id of new weapon, based on the inventory weapon's name (this is different from the Id of the weapon that can be picked up in the map).

PrimaryAmmo

protected int PrimaryAmmo

Holding current primary ammo of the new weapon.

SecondaryAmmo

protected int SecondaryAmmo

Holding current secondary ammo of the new weapon.

Type

protected java.lang.String Type

A string representing the type of the weapon.

Constructor Detail

ChangedWeapon

public ChangedWeapon()

Parameter-less contructor for the message.

ChangedWeapon

public ChangedWeapon(java.lang.String Id,
                     int PrimaryAmmo,
                     int SecondaryAmmo,
                     java.lang.String Type)

Creates new instance of the message ChangedWeapon. Asynchronous message. Bot changed weapon. Possibly as a result of a command sent by you. Here we will get the new weapon - the weapon the bot has changed to. Corresponding GameBots message is CWP.

Parameters:

Id - Unique Id of new weapon, based on the inventory weapon's name (this is different from the Id of the weapon that can be picked up in the map).

PrimaryAmmo - Holding current primary ammo of the new weapon.

SecondaryAmmo - Holding current secondary ammo of the new weapon.

Type - A string representing the type of the weapon.

ChangedWeapon

public ChangedWeapon(ChangedWeapon original)

Cloning constructor from the full message.

Parameters:

original -

Method Detail

getSimTime

public long getSimTime()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getId

public java.lang.String getId()

Unique Id of new weapon, based on the inventory weapon's name (this is different from the Id of the weapon that can be picked up in the map).

getPrimaryAmmo

public int getPrimaryAmmo()

Holding current primary ammo of the new weapon.

getSecondaryAmmo

public int getSecondaryAmmo()

Holding current secondary ammo of the new weapon.

getType

public java.lang.String getType()

A string representing the type of the weapon.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()