cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands
Class PlayAnimation

java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.PlayAnimation

public class PlayAnimation
extends CommandMessage

Representation of the GameBots2004 command ACT. Will trigger some of the native animations.


Field Summary
protected  java.lang.Boolean Loop
          When true the animation will be played in loop.
protected  java.lang.String Name
          Name of the animation.
static java.lang.String PROTOTYPE
          Example how the message looks like - used during parser tests.
 
Constructor Summary
PlayAnimation()
          Creates new instance of command PlayAnimation.
PlayAnimation(PlayAnimation original)
          Cloning constructor.
PlayAnimation(java.lang.String Name, java.lang.Boolean Loop)
          Creates new instance of command PlayAnimation.
 
Method Summary
 java.lang.String getName()
          Name of the animation.
 java.lang.Boolean isLoop()
          When true the animation will be played in loop.
 PlayAnimation setLoop(java.lang.Boolean Loop)
          When true the animation will be played in loop.
 PlayAnimation setName(java.lang.String Name)
          Name of the animation.
 java.lang.String toHtmlString()
           
 java.lang.String toMessage()
           
 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

Name

protected java.lang.String Name
Name of the animation. Possible animations: gesture_beckon, gesture_cheer, gesture_halt, gesture_point, Gesture_Taunt01, PThrust, AssSmack, ThroatCut, Specific_1, Gesture_Taunt02, Idle_Character02, Idle_Character03, Gesture_Taunt03.


Loop

protected java.lang.Boolean Loop
When true the animation will be played in loop. Supported un GameBotsUE2.

Constructor Detail

PlayAnimation

public PlayAnimation(java.lang.String Name,
                     java.lang.Boolean Loop)
Creates new instance of command PlayAnimation. Will trigger some of the native animations. Corresponding GameBots message for this command is ACT.

Parameters:
Name - Name of the animation. Possible animations: gesture_beckon, gesture_cheer, gesture_halt, gesture_point, Gesture_Taunt01, PThrust, AssSmack, ThroatCut, Specific_1, Gesture_Taunt02, Idle_Character02, Idle_Character03, Gesture_Taunt03.
Loop - When true the animation will be played in loop. Supported un GameBotsUE2.

PlayAnimation

public PlayAnimation()
Creates new instance of command PlayAnimation. Will trigger some of the native animations. Corresponding GameBots message for this command is ACT.

WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!


PlayAnimation

public PlayAnimation(PlayAnimation original)
Cloning constructor.

Parameters:
original -
Method Detail

getName

public java.lang.String getName()
Name of the animation. Possible animations: gesture_beckon, gesture_cheer, gesture_halt, gesture_point, Gesture_Taunt01, PThrust, AssSmack, ThroatCut, Specific_1, Gesture_Taunt02, Idle_Character02, Idle_Character03, Gesture_Taunt03.


setName

public PlayAnimation setName(java.lang.String Name)
Name of the animation. Possible animations: gesture_beckon, gesture_cheer, gesture_halt, gesture_point, Gesture_Taunt01, PThrust, AssSmack, ThroatCut, Specific_1, Gesture_Taunt02, Idle_Character02, Idle_Character03, Gesture_Taunt03.


isLoop

public java.lang.Boolean isLoop()
When true the animation will be played in loop. Supported un GameBotsUE2.


setLoop

public PlayAnimation setLoop(java.lang.Boolean Loop)
When true the animation will be played in loop. Supported un GameBotsUE2.


toString

public java.lang.String toString()
Overrides:
toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()