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

Package class diagram package PlayerKilled
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.PlayerKilled
All Implemented Interfaces:
IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class PlayerKilled
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event KIL.

Complete message documentation: Asynchronous message. Some other player died - reporting his death. Additional information about DamageType - DeathString and so are exported just if we can see the dying player.


Field Summary
protected  boolean BulletHit
          If this damage was caused by bullet.
protected  boolean CausedByWorld
          If this damage was caused by world - falling into lava, or falling down.
protected  String DamageType
          A string describing what kind of damage killed the victim.
protected  String DeathString
          String describing this type of death.
protected  boolean DirectDamage
          If the damage is direct.
protected  boolean Flaming
          If this damage is causing the player to burn.
protected  UnrealId Id
          Unique Id of the dead player.
protected  String KilledPawn
          The UT Pawn that was killed - support for vehicles.
protected  UnrealId Killer
          Unique Id of player that killed if any (the victim might have walked off a ledge).
static 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 us.
protected  String WeaponName
          Name of the weapon that caused this damage.
 
Constructor Summary
PlayerKilled()
          Parameter-less contructor for the message.
PlayerKilled(PlayerKilled original)
          Cloning constructor from the full message.
PlayerKilled(UnrealId Id, UnrealId Killer, String KilledPawn, String DamageType, String DeathString, String WeaponName, boolean Flaming, boolean CausedByWorld, boolean DirectDamage, boolean BulletHit, boolean VehicleHit)
          Creates new instance of the message PlayerKilled.
 
Method Summary
 String getDamageType()
          A string describing what kind of damage killed the victim.
 String getDeathString()
          String describing this type of death.
 UnrealId getId()
          Unique Id of the dead player.
 String getKilledPawn()
          The UT Pawn that was killed - support for vehicles.
 UnrealId getKiller()
          Unique Id of player that killed if any (the victim might have walked off a ledge).
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
 String getWeaponName()
          Name of the weapon that caused this damage.
 boolean isBulletHit()
          If this damage was caused by bullet.
 boolean isCausedByWorld()
          If this damage was caused by world - falling into lava, or falling down.
 boolean isDirectDamage()
          If the damage is direct.
 boolean isFlaming()
          If this damage is causing the player to burn.
 boolean isVehicleHit()
          If this damage was caused by vehicle running over us.
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 UnrealId Id
Unique Id of the dead player.


Killer

protected UnrealId Killer
Unique Id of player that killed if any (the victim might have walked off a ledge).


KilledPawn

protected String KilledPawn
The UT Pawn that was killed - support for vehicles. If someone destroyes vehicle we will get it here (Id will be none and in KilledPawn we will have destroyed vehicle).


DamageType

protected String DamageType
A string describing what kind of damage killed the victim.


DeathString

protected String DeathString
String describing this type of death.


WeaponName

protected String WeaponName
Name of the weapon that caused this damage.


Flaming

protected boolean Flaming
If this damage is causing the player to burn. TODO


CausedByWorld

protected boolean CausedByWorld
If this damage was caused by world - falling into lava, or falling down.


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 us.

Constructor Detail

PlayerKilled

public PlayerKilled()
Parameter-less contructor for the message.


PlayerKilled

public PlayerKilled(UnrealId Id,
                    UnrealId Killer,
                    String KilledPawn,
                    String DamageType,
                    String DeathString,
                    String WeaponName,
                    boolean Flaming,
                    boolean CausedByWorld,
                    boolean DirectDamage,
                    boolean BulletHit,
                    boolean VehicleHit)
Creates new instance of the message PlayerKilled. Asynchronous message. Some other player died - reporting his death. Additional information about DamageType - DeathString and so are exported just if we can see the dying player. Corresponding GameBots message is KIL.

Parameters:
Id - Unique Id of the dead player.
Killer - Unique Id of player that killed if any (the victim might have walked off a ledge).
KilledPawn - The UT Pawn that was killed - support for vehicles. If someone destroyes vehicle we will get it here (Id will be none and in KilledPawn we will have destroyed vehicle).
DamageType - A string describing what kind of damage killed the victim.
DeathString - String describing this type of death.
WeaponName - Name of the weapon that caused this damage.
Flaming - If this damage is causing the player to burn. TODO
CausedByWorld - If this damage was caused by world - falling into lava, or falling down.
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 us.

PlayerKilled

public PlayerKilled(PlayerKilled 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 UnrealId getId()
Unique Id of the dead player.


getKiller

public UnrealId getKiller()
Unique Id of player that killed if any (the victim might have walked off a ledge).


getKilledPawn

public String getKilledPawn()
The UT Pawn that was killed - support for vehicles. If someone destroyes vehicle we will get it here (Id will be none and in KilledPawn we will have destroyed vehicle).


getDamageType

public String getDamageType()
A string describing what kind of damage killed the victim.


getDeathString

public String getDeathString()
String describing this type of death.


getWeaponName

public String getWeaponName()
Name of the weapon that caused this damage.


isFlaming

public boolean isFlaming()
If this damage is causing the player to burn. TODO


isCausedByWorld

public boolean isCausedByWorld()
If this damage was caused by world - falling into lava, or falling down.


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 us.


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()
Overrides:
toJsonLiteral in class InfoMessage


Copyright © 2014 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.