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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class VolumeChanged
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event VCH.

Complete message documentation: Asynchronous message. Some part of the bot body changed the zone.

Field Summary

protected double	DamagePerSec Amount of damage we will suffer per second if we stay in this zone.
protected java.lang.String	DamageType Type of the damage in this zone.
protected boolean	Destructive If this zone kills most of the actors instantly.
protected double	FluidFriction Friction of the fluid.
protected double	GroundFriction Friction of the floor.
protected java.lang.String	Id Id of the zone entered.
protected boolean	MoveProjectiles If this velocity zone should impart velocity to projectiles and effects.
protected boolean	NeutralZone Players can't take damage in this zone.
protected boolean	NoInventory If the inventory is allowed here.
protected boolean	PainCausing True or false if we get some damage when we stay in this zone.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected double	TerminalVelocity Terminal velocity (?).
protected boolean	WaterVolume If this zone is a water.
protected Velocity	ZoneGravity Gravity in this zone.
protected Velocity	ZoneVelocity Zone velocity (?).

Constructor Summary

VolumeChanged()
Parameter-less contructor for the message.

VolumeChanged(java.lang.String Id, Velocity ZoneVelocity, Velocity ZoneGravity, double GroundFriction, double FluidFriction, double TerminalVelocity, boolean WaterVolume, boolean PainCausing, boolean Destructive, double DamagePerSec, java.lang.String DamageType, boolean NoInventory, boolean MoveProjectiles, boolean NeutralZone)
Creates new instance of the message VolumeChanged.

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

Method Summary

double	getDamagePerSec() Amount of damage we will suffer per second if we stay in this zone.
java.lang.String	getDamageType() Type of the damage in this zone.
double	getFluidFriction() Friction of the fluid.
double	getGroundFriction() Friction of the floor.
java.lang.String	getId() Id of the zone entered.
long	getSimTime() Returns the simulation time when the event has occurred.
double	getTerminalVelocity() Terminal velocity (?).
Velocity	getZoneGravity() Gravity in this zone.
Velocity	getZoneVelocity() Zone velocity (?).
boolean	isDestructive() If this zone kills most of the actors instantly.
boolean	isMoveProjectiles() If this velocity zone should impart velocity to projectiles and effects.
boolean	isNeutralZone() Players can't take damage in this zone.
boolean	isNoInventory() If the inventory is allowed here.
boolean	isPainCausing() True or false if we get some damage when we stay in this zone.
boolean	isWaterVolume() If this zone is a water.
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 java.lang.String Id

Id of the zone entered.

ZoneVelocity

protected Velocity ZoneVelocity

Zone velocity (?).

ZoneGravity

protected Velocity ZoneGravity

Gravity in this zone.

GroundFriction

protected double GroundFriction

Friction of the floor.

FluidFriction

protected double FluidFriction

Friction of the fluid.

TerminalVelocity

protected double TerminalVelocity

Terminal velocity (?).

WaterVolume

protected boolean WaterVolume

If this zone is a water.

PainCausing

protected boolean PainCausing

True or false if we get some damage when we stay in this zone.

Destructive

protected boolean Destructive

If this zone kills most of the actors instantly.

DamagePerSec

protected double DamagePerSec

Amount of damage we will suffer per second if we stay in this zone.

DamageType

protected java.lang.String DamageType

Type of the damage in this zone.

NoInventory

protected boolean NoInventory

If the inventory is allowed here.

MoveProjectiles

protected boolean MoveProjectiles

If this velocity zone should impart velocity to projectiles and effects.

NeutralZone

protected boolean NeutralZone

Players can't take damage in this zone.

Constructor Detail

VolumeChanged

public VolumeChanged()

Parameter-less contructor for the message.

VolumeChanged

public VolumeChanged(java.lang.String Id,
                     Velocity ZoneVelocity,
                     Velocity ZoneGravity,
                     double GroundFriction,
                     double FluidFriction,
                     double TerminalVelocity,
                     boolean WaterVolume,
                     boolean PainCausing,
                     boolean Destructive,
                     double DamagePerSec,
                     java.lang.String DamageType,
                     boolean NoInventory,
                     boolean MoveProjectiles,
                     boolean NeutralZone)

Creates new instance of the message VolumeChanged. Asynchronous message. Some part of the bot body changed the zone. Corresponding GameBots message is VCH.

Parameters:

Id - Id of the zone entered.

ZoneVelocity - Zone velocity (?).

ZoneGravity - Gravity in this zone.

GroundFriction - Friction of the floor.

FluidFriction - Friction of the fluid.

TerminalVelocity - Terminal velocity (?).

WaterVolume - If this zone is a water.

PainCausing - True or false if we get some damage when we stay in this zone.

Destructive - If this zone kills most of the actors instantly.

DamagePerSec - Amount of damage we will suffer per second if we stay in this zone.

DamageType - Type of the damage in this zone.

NoInventory - If the inventory is allowed here.

MoveProjectiles - If this velocity zone should impart velocity to projectiles and effects.

NeutralZone - Players can't take damage in this zone.

VolumeChanged

public VolumeChanged(VolumeChanged 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 java.lang.String getId()

Id of the zone entered.

getZoneVelocity

public Velocity getZoneVelocity()

Zone velocity (?).

getZoneGravity

public Velocity getZoneGravity()

Gravity in this zone.

getGroundFriction

public double getGroundFriction()

Friction of the floor.

getFluidFriction

public double getFluidFriction()

Friction of the fluid.

getTerminalVelocity

public double getTerminalVelocity()

Terminal velocity (?).

isWaterVolume

public boolean isWaterVolume()

If this zone is a water.

isPainCausing

public boolean isPainCausing()

True or false if we get some damage when we stay in this zone.

isDestructive

public boolean isDestructive()

If this zone kills most of the actors instantly.

getDamagePerSec

public double getDamagePerSec()

Amount of damage we will suffer per second if we stay in this zone.

getDamageType

public java.lang.String getDamageType()

Type of the damage in this zone.

isNoInventory

public boolean isNoInventory()

If the inventory is allowed here.

isMoveProjectiles

public boolean isMoveProjectiles()

If this velocity zone should impart velocity to projectiles and effects.

isNeutralZone

public boolean isNeutralZone()

Players can't take damage in this zone.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()