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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, IWorldObject, ICompositeWorldObject, Event

Direct Known Subclasses:

MyInventoryCompositeImpl, MyInventoryMessage

public abstract class MyInventory
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent, ICompositeWorldObject

Abstract definition of the GameBots2004 message MYINV.

Complete message documentation: An object in the observed player's inventory.

Nested Class Summary

static class

MyInventory.MyInventoryUpdate

Field Summary

static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime

Constructor Summary

MyInventory()
Parameter-less contructor for the message.

Method Summary

abstract int	getAmount() If this item is ammo or armor, this holds the amount of the item the player has.
abstract int	getCurrentAltAmmo() If this item is a weapon, this holds the amount of secondary ammo.
abstract int	getCurrentAmmo() If this item is a weapon, this holds the amount of primary ammo.
abstract ItemDescriptor	getDescriptor() Descriptor of the item - according the ItemType you may cast this to various XYZDescriptor.
abstract UnrealId	getId() Unique Id of the item.
long	getSimTime() Returns the simulation time when the event has occurred.
abstract ItemType	getType() Class of the item (e.g.
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

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ICompositeWorldObject

getLocal, getShared, getStatic

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

Constructor Detail

MyInventory

public MyInventory()

Parameter-less contructor for the message.

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

Specified by:

getSimTime in interface IWorldObject

Returns:

timestamp

setSimTime

protected void setSimTime(long SimTime)

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

getId

public abstract UnrealId getId()

Unique Id of the item. This Id represents the item in the inventory.

Specified by:

getId in interface IWorldObject

Returns:

getCurrentAmmo

public abstract int getCurrentAmmo()

If this item is a weapon, this holds the amount of primary ammo.

getCurrentAltAmmo

public abstract int getCurrentAltAmmo()

If this item is a weapon, this holds the amount of secondary ammo.

getAmount

public abstract int getAmount()

If this item is ammo or armor, this holds the amount of the item the player has.

getType

public abstract ItemType getType()

Class of the item (e.g. xWeapons.FlakCannonPickup).

getDescriptor

public abstract ItemDescriptor getDescriptor()

Descriptor of the item - according the ItemType you may cast this to various XYZDescriptor.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()