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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class PlayerDamaged
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event HIT.

Complete message documentation: Asynchronous message. Bot hurt another player. Hit them with a shot.

Field Summary

protected boolean	BulletHit If this damage was caused by bullet.
protected int	Damage Amount of damage done.
protected java.lang.String	DamageType A string describing what kind of damage.
protected boolean	DirectDamage If the damage is direct.
protected boolean	Flaming If this damage is causing our bot to burn.
protected UnrealId	Id Unique Id of the player hit.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected boolean	VehicleHit If this damage was caused by vehicle running over.
protected java.lang.String	WeaponName Name of the weapon that caused this damage.

Constructor Summary

PlayerDamaged()
Parameter-less contructor for the message.

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

PlayerDamaged(UnrealId Id, int Damage, java.lang.String DamageType, java.lang.String WeaponName, boolean Flaming, boolean DirectDamage, boolean BulletHit, boolean VehicleHit)
Creates new instance of the message PlayerDamaged.

Method Summary

int	getDamage() Amount of damage done.
java.lang.String	getDamageType() A string describing what kind of damage.
UnrealId	getId() Unique Id of the player hit.
long	getSimTime() Returns the simulation time when the event has occurred.
java.lang.String	getWeaponName() Name of the weapon that caused this damage.
boolean	isBulletHit() If this damage was caused by bullet.
boolean	isDirectDamage() If the damage is direct.
boolean	isFlaming() If this damage is causing our bot to burn.
boolean	isVehicleHit() If this damage was caused by vehicle running over.
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 UnrealId Id

Unique Id of the player hit.

Damage

protected int Damage

Amount of damage done.

DamageType

protected java.lang.String DamageType

A string describing what kind of damage.

WeaponName

protected java.lang.String WeaponName

Name of the weapon that caused this damage.

Flaming

protected boolean Flaming

If this damage is causing our bot to burn. TODO

DirectDamage

protected boolean DirectDamage

If the damage is direct. TODO

BulletHit

protected boolean BulletHit

If this damage was caused by bullet.

VehicleHit

protected boolean VehicleHit

If this damage was caused by vehicle running over.

Constructor Detail

PlayerDamaged

public PlayerDamaged()

Parameter-less contructor for the message.

PlayerDamaged

public PlayerDamaged(UnrealId Id,
                     int Damage,
                     java.lang.String DamageType,
                     java.lang.String WeaponName,
                     boolean Flaming,
                     boolean DirectDamage,
                     boolean BulletHit,
                     boolean VehicleHit)

Creates new instance of the message PlayerDamaged. Asynchronous message. Bot hurt another player. Hit them with a shot. Corresponding GameBots message is HIT.

Parameters:

Id - Unique Id of the player hit.

Damage - Amount of damage done.

DamageType - A string describing what kind of damage.

WeaponName - Name of the weapon that caused this damage.

Flaming - If this damage is causing our bot to burn. TODO

DirectDamage - If the damage is direct. TODO

BulletHit - If this damage was caused by bullet.

VehicleHit - If this damage was caused by vehicle running over.

PlayerDamaged

public PlayerDamaged(PlayerDamaged 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 UnrealId getId()

Unique Id of the player hit.

getDamage

public int getDamage()

Amount of damage done.

getDamageType

public java.lang.String getDamageType()

A string describing what kind of damage.

getWeaponName

public java.lang.String getWeaponName()

Name of the weapon that caused this damage.

isFlaming

public boolean isFlaming()

If this damage is causing our bot to burn. TODO

isDirectDamage

public boolean isDirectDamage()

If the damage is direct. TODO

isBulletHit

public boolean isBulletHit()

If this damage was caused by bullet.

isVehicleHit

public boolean isVehicleHit()

If this damage was caused by vehicle running over.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()