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

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

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, Event

public class AnimationChange
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event CHANGEANIM.

Complete message documentation: Asynchronous message. Bot starts or finishes custom played animation. If a list of animation was supported, this message will come each time an animation in the list starts or stops playing.

Field Summary

protected boolean	AnimEnd True if this animation has ended.
protected boolean	AnimStart True if this animation has now started.
protected java.lang.String	Name Name of the animation.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected long	SimTime
protected double	Time Time of the animation change.

Constructor Summary

AnimationChange()
Parameter-less contructor for the message.

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

AnimationChange(java.lang.String Name, boolean AnimStart, boolean AnimEnd, double Time)
Creates new instance of the message AnimationChange.

Method Summary

java.lang.String	getName() Name of the animation.
long	getSimTime() Returns the simulation time when the event has occurred.
double	getTime() Time of the animation change.
boolean	isAnimEnd() True if this animation has ended.
boolean	isAnimStart() True if this animation has now started.
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

Name

protected java.lang.String Name

Name of the animation.

AnimStart

protected boolean AnimStart

True if this animation has now started.

AnimEnd

protected boolean AnimEnd

True if this animation has ended.

Time

protected double Time

Time of the animation change.

Constructor Detail

AnimationChange

public AnimationChange()

Parameter-less contructor for the message.

AnimationChange

public AnimationChange(java.lang.String Name,
                       boolean AnimStart,
                       boolean AnimEnd,
                       double Time)

Creates new instance of the message AnimationChange. Asynchronous message. Bot starts or finishes custom played animation. If a list of animation was supported, this message will come each time an animation in the list starts or stops playing. Corresponding GameBots message is CHANGEANIM.

Parameters:

Name - Name of the animation.

AnimStart - True if this animation has now started.

AnimEnd - True if this animation has ended.

Time - Time of the animation change.

AnimationChange

public AnimationChange(AnimationChange 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.

getName

public java.lang.String getName()

Name of the animation.

isAnimStart

public boolean isAnimStart()

True if this animation has now started.

isAnimEnd

public boolean isAnimEnd()

True if this animation has ended.

getTime

public double getTime()

Time of the animation change.

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()