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

All Implemented Interfaces:

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

Fields
Modifier and Type	Field and Description
`protected boolean`	`AnimEnd` True if this animation has ended.
`protected boolean`	`AnimStart` True if this animation has now started.
`protected String`	`Name` Name of the animation.
`static 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

Constructors
Constructor and Description
`AnimationChange()` Parameter-less contructor for the message.
`AnimationChange(AnimationChange original)` Cloning constructor from the full message.
`AnimationChange(String Name, boolean AnimStart, boolean AnimEnd, double Time)` Creates new instance of the message AnimationChange.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getName()` Name of the animation.
`long`	`getSimTime()` Simulation time in MILLI SECONDS !!!
`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.
`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
```
  - Name
```
protected 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(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()
```
    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.
  - getName
```
public 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 String toString()
```
    Overrides:
    
    toString in class InfoMessage
  - toHtmlString
```
public String toHtmlString()
```
  - toJsonLiteral
```
public String toJsonLiteral()
```
    Overrides:
    
    toJsonLiteral in class InfoMessage

Class AnimationChange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOTYPE

SimTime

Name

AnimStart

AnimEnd

Time

Constructor Detail

AnimationChange

AnimationChange

AnimationChange

Method Detail

getSimTime

setSimTime

getName

isAnimStart

isAnimEnd

getTime

toString

toHtmlString

toJsonLiteral