ItemMessage

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: IWorldChangeEvent, IWorldObjectUpdatedEvent, IWorldEvent, IWorldObject, ILocated, IViewable, ICompositeWorldObject, ItemTyped, IGBViewable, Event

public class ItemMessage
extends Item
implements IWorldObjectUpdatedEvent
extends Item
implements IWorldObjectUpdatedEvent

Implementation of the GameBots2004 message INV contains also its Local/Shared/Static subpart class definitions..

Complete message documentation: Synchronous/asynchronous message. An object on the ground that can be picked up.

Nested Class Summary
`class`	`ItemMessage.ItemLocalMessage` Implementation of the local part of the GameBots2004 message INV, used to facade INVMessage.
`class`	`ItemMessage.ItemSharedMessage` Implementation of the shared part of the GameBots2004 message INV, used to facade INVMessage.
`class`	`ItemMessage.ItemStaticMessage` Implementation of the static part of the GameBots2004 message INV, used to facade INVMessage.

Nested classes/interfaces inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Item
`Item.ItemUpdate, Item.ObjectDisappeared`

Field Summary
`protected int`	`Amount` If this item is some ammo or health pack, here we can find out how much of the attribute this item will add.
`protected ItemDescriptor`	`Descriptor` Descriptor of the item - according the ItemType you may cast this to various XYZDescriptor.
`protected boolean`	`Dropped` Whether it is regular item or one dropped by some bot (usually during dying).
`protected UnrealId`	`Id` Unique Id of the item.
`protected Location`	`Location` Location of the item.
`protected NavPoint`	`NavPoint` If the Item is not dropped then it's item that is laying at some navpoint and this is that NavPoint instance.
`protected UnrealId`	`NavPointId` Id of the navpoint where the item is laying.
`protected boolean`	`Reachable` True if agent can reach the item.
`protected ITeamId`	`TeamId`
`protected ItemType`	`Type` Class of the item (e.g.
`protected boolean`	`Visible` If the item is in the field of view of the bot.

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Item
`PROTOTYPE, SimTime`

Constructor Summary
`ItemMessage()` Parameter-less contructor for the message.
`ItemMessage(ItemMessage original)` Cloning constructor from the full message.
`ItemMessage(UnrealId Id, UnrealId NavPointId, NavPoint NavPoint, boolean Visible, Location Location, boolean Reachable, int Amount, ItemType Type, ItemDescriptor Descriptor, boolean Dropped)` Creates new instance of the message Item.

Method Summary
`int`	`getAmount()` If this item is some ammo or health pack, here we can find out how much of the attribute this item will add.
`ItemDescriptor`	`getDescriptor()` Descriptor of the item - according the ItemType you may cast this to various XYZDescriptor.
`UnrealId`	`getId()` Unique Id of the item.
`ItemLocal`	`getLocal()`
`Location`	`getLocation()` Location of the item.
`NavPoint`	`getNavPoint()` If the Item is not dropped then it's item that is laying at some navpoint and this is that NavPoint instance.
`UnrealId`	`getNavPointId()` Id of the navpoint where the item is laying.
`ItemShared`	`getShared()`
`ItemStatic`	`getStatic()`
`ITeamId`	`getTeamId()`
`ItemType`	`getType()` Class of the item (e.g.
`boolean`	`isDropped()` Whether it is regular item or one dropped by some bot (usually during dying).
`boolean`	`isReachable()` True if agent can reach the item.
`boolean`	`isVisible()` If the item is in the field of view of the bot.
`void`	`setNavPoint(NavPoint navPoint)` DO NOT USE THIS METHOD! Reserved for GaviaLib (Pogamut core)! It's used to set correct navpoint instance into the item.
`protected void`	`setTeamId(ITeamId TeamId)` Used by Yylex to slip corretn TeamId.
`java.lang.String`	`toHtmlString()`
`java.lang.String`	`toString()`
`IWorldObjectUpdateResult<IWorldObject>`	`update(IWorldObject object)`

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.Item
`createDisappearEvent, getSimTime, setSimTime`

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.base.communication.translator.event.IWorldChangeEvent
`getSimTime`

Field Detail

TeamId

protected ITeamId TeamId

Id

protected UnrealId Id

Unique Id of the item. This Id represents just item on the map, not in our inventory.

NavPointId

protected UnrealId NavPointId

Id of the navpoint where the item is laying. If null - the item was dropped by the bot or another player.

NavPoint

protected NavPoint NavPoint

If the Item is not dropped then it's item that is laying at some navpoint and this is that NavPoint instance.

Visible

protected boolean Visible

If the item is in the field of view of the bot.

Location

protected Location Location

Location of the item.

Reachable

protected boolean Reachable

True if agent can reach the item.

Amount

protected int Amount

If this item is some ammo or health pack, here we can find out how much of the attribute this item will add.

Type

protected ItemType Type

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

Descriptor

protected ItemDescriptor Descriptor

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

Dropped

protected boolean Dropped

Whether it is regular item or one dropped by some bot (usually during dying). Items that are not dropped usually respawns itself (depends on the game settings) while those that are dropped may be taken only once.

Constructor Detail

ItemMessage

public ItemMessage()

Parameter-less contructor for the message.

ItemMessage

public ItemMessage(UnrealId Id,
                   UnrealId NavPointId,
                   NavPoint NavPoint,
                   boolean Visible,
                   Location Location,
                   boolean Reachable,
                   int Amount,
                   ItemType Type,
                   ItemDescriptor Descriptor,
                   boolean Dropped)

Creates new instance of the message Item. Synchronous/asynchronous message. An object on the ground that can be picked up. Corresponding GameBots message is INV.

Parameters:: Id - Unique Id of the item. This Id represents just item on the map, not in our inventory.; NavPointId - Id of the navpoint where the item is laying. If null - the item was dropped by the bot or another player.; NavPoint - If the Item is not dropped then it's item that is laying at some navpoint and this is that NavPoint instance.; Visible - If the item is in the field of view of the bot.; Location - Location of the item.; Reachable - True if agent can reach the item.; Amount - If this item is some ammo or health pack, here we can find out how much of the attribute this item will add.; Type - Class of the item (e.g. xWeapons.FlakCannonPickup).; Descriptor - Descriptor of the item - according the ItemType you may cast this to various XYZDescriptor.; Dropped - Whether it is regular item or one dropped by some bot (usually during dying). Items that are not dropped usually respawns itself (depends on the game settings) while those that are dropped may be taken only once.

ItemMessage

public ItemMessage(ItemMessage original)

Cloning constructor from the full message.

Parameters:: original -

Method Detail

setTeamId

protected void setTeamId(ITeamId TeamId)

Used by Yylex to slip corretn TeamId.