ChangedWeapon (pogamut-ut2004 3.3.1-SNAPSHOT API)

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, cz.cuni.amis.utils.listener.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

Fields
Modifier and Type	Field and Description
`protected 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 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 String`	`Type` A string representing the type of the weapon.

Constructor Summary

Constructors
Constructor and Description
`ChangedWeapon()` Parameter-less contructor for the message.
`ChangedWeapon(ChangedWeapon original)` Cloning constructor from the full message.
`ChangedWeapon(String Id, int PrimaryAmmo, int SecondaryAmmo, String Type)` Creates new instance of the message ChangedWeapon.

Method Summary

Methods
Modifier and Type	Method and Description
`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()` Simulation time in MILLI SECONDS !!!
`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.
`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
```
  - Id
```
protected 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 String Type
```
    A string representing the type of the weapon.
- Constructor Detail
  - ChangedWeapon
```
public ChangedWeapon()
```
    Parameter-less contructor for the message.
  - ChangedWeapon
```
public ChangedWeapon(String Id,
             int PrimaryAmmo,
             int SecondaryAmmo,
             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()
```
    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.
  - getId
```
public 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 String getType()
```
    A string representing the type of the weapon.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class InfoMessage
  - toHtmlString
```
public String toHtmlString()
```
  - toJsonLiteral
```
public String toJsonLiteral()
```
    Overrides:
    
    toJsonLiteral in class InfoMessage

Class ChangedWeapon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOTYPE

SimTime

Id

PrimaryAmmo

SecondaryAmmo

Type

Constructor Detail

ChangedWeapon

ChangedWeapon

ChangedWeapon

Method Detail

getSimTime

setSimTime

getId

getPrimaryAmmo

getSecondaryAmmo

getType

toString

toHtmlString

toJsonLiteral