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

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

public class SetEmotionalEmitter
extends CommandMessage

Representation of the GameBots2004 command SETEMIT. Sets the emotional emitter for the bot and configures it. The emitter will float at the bots head following the bot.


Field Summary
protected  java.lang.Boolean Disable
          If true disables actual emittor (it will dissappear).
protected  Velocity EndVelocity
          This is relative velocity direction vector that will affect the speed and direction of the balls going in.
protected  Vector3d FadeTime
          This will affect the fade in and fade out times of the balls.
protected  Vector3d FirstC
          Starting color of the floating balls.
protected  java.lang.Double LifeTime
          This will affect the life time of the balls and radius and speed they will be traversing.
protected  java.lang.Boolean Pause
          Should pause the emitter, does not work right now.
static java.lang.String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  Vector3d SecondC
          Finishing color of the floating balls.
protected  Vector3d Size
          This will affect the size of the balls.
protected  Velocity StartVelocity
          This is relative velocity direction vector that will affect the speed and direction of the balls going out.
protected  java.lang.Double VelocityRange
          This will affect the speed of the balls.
 
Constructor Summary
SetEmotionalEmitter()
          Creates new instance of command SetEmotionalEmitter.
SetEmotionalEmitter(java.lang.Boolean Disable, java.lang.Boolean Pause, Vector3d FirstC, Vector3d SecondC, Velocity StartVelocity, Velocity EndVelocity, java.lang.Double VelocityRange, Vector3d Size, java.lang.Double LifeTime, Vector3d FadeTime)
          Creates new instance of command SetEmotionalEmitter.
SetEmotionalEmitter(SetEmotionalEmitter original)
          Cloning constructor.
 
Method Summary
 Velocity getEndVelocity()
          This is relative velocity direction vector that will affect the speed and direction of the balls going in.
 Vector3d getFadeTime()
          This will affect the fade in and fade out times of the balls.
 Vector3d getFirstC()
          Starting color of the floating balls.
 java.lang.Double getLifeTime()
          This will affect the life time of the balls and radius and speed they will be traversing.
 Vector3d getSecondC()
          Finishing color of the floating balls.
 Vector3d getSize()
          This will affect the size of the balls.
 Velocity getStartVelocity()
          This is relative velocity direction vector that will affect the speed and direction of the balls going out.
 java.lang.Double getVelocityRange()
          This will affect the speed of the balls.
 java.lang.Boolean isDisable()
          If true disables actual emittor (it will dissappear).
 java.lang.Boolean isPause()
          Should pause the emitter, does not work right now.
 SetEmotionalEmitter setDisable(java.lang.Boolean Disable)
          If true disables actual emittor (it will dissappear).
 SetEmotionalEmitter setEndVelocity(Velocity EndVelocity)
          This is relative velocity direction vector that will affect the speed and direction of the balls going in.
 SetEmotionalEmitter setFadeTime(Vector3d FadeTime)
          This will affect the fade in and fade out times of the balls.
 SetEmotionalEmitter setFirstC(Vector3d FirstC)
          Starting color of the floating balls.
 SetEmotionalEmitter setLifeTime(java.lang.Double LifeTime)
          This will affect the life time of the balls and radius and speed they will be traversing.
 SetEmotionalEmitter setPause(java.lang.Boolean Pause)
          Should pause the emitter, does not work right now.
 SetEmotionalEmitter setSecondC(Vector3d SecondC)
          Finishing color of the floating balls.
 SetEmotionalEmitter setSize(Vector3d Size)
          This will affect the size of the balls.
 SetEmotionalEmitter setStartVelocity(Velocity StartVelocity)
          This is relative velocity direction vector that will affect the speed and direction of the balls going out.
 SetEmotionalEmitter setVelocityRange(java.lang.Double VelocityRange)
          This will affect the speed of the balls.
 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

Disable

protected java.lang.Boolean Disable
If true disables actual emittor (it will dissappear). No other attributes will be parsed.


Pause

protected java.lang.Boolean Pause
Should pause the emitter, does not work right now.


FirstC

protected Vector3d FirstC
Starting color of the floating balls.


SecondC

protected Vector3d SecondC
Finishing color of the floating balls.


StartVelocity

protected Velocity StartVelocity
This is relative velocity direction vector that will affect the speed and direction of the balls going out. Default (2,2,2).


EndVelocity

protected Velocity EndVelocity
This is relative velocity direction vector that will affect the speed and direction of the balls going in. Default (-10,-10,-10).


VelocityRange

protected java.lang.Double VelocityRange
This will affect the speed of the balls. Default -20.


Size

protected Vector3d Size
This will affect the size of the balls. Default (4,4,8).


LifeTime

protected java.lang.Double LifeTime
This will affect the life time of the balls and radius and speed they will be traversing. Default 1.6.


FadeTime

protected Vector3d FadeTime
This will affect the fade in and fade out times of the balls. First value affects the starting fade out time. Second value will affect ending fade in time. The third value in the vector is ignored.

Constructor Detail

SetEmotionalEmitter

public SetEmotionalEmitter(java.lang.Boolean Disable,
                           java.lang.Boolean Pause,
                           Vector3d FirstC,
                           Vector3d SecondC,
                           Velocity StartVelocity,
                           Velocity EndVelocity,
                           java.lang.Double VelocityRange,
                           Vector3d Size,
                           java.lang.Double LifeTime,
                           Vector3d FadeTime)
Creates new instance of command SetEmotionalEmitter. Sets the emotional emitter for the bot and configures it. The emitter will float at the bots head following the bot. Corresponding GameBots message for this command is SETEMIT.

Parameters:
Disable - If true disables actual emittor (it will dissappear). No other attributes will be parsed.
Pause - Should pause the emitter, does not work right now.
FirstC - Starting color of the floating balls.
SecondC - Finishing color of the floating balls.
StartVelocity - This is relative velocity direction vector that will affect the speed and direction of the balls going out. Default (2,2,2).
EndVelocity - This is relative velocity direction vector that will affect the speed and direction of the balls going in. Default (-10,-10,-10).
VelocityRange - This will affect the speed of the balls. Default -20.
Size - This will affect the size of the balls. Default (4,4,8).
LifeTime - This will affect the life time of the balls and radius and speed they will be traversing. Default 1.6.
FadeTime - This will affect the fade in and fade out times of the balls. First value affects the starting fade out time. Second value will affect ending fade in time. The third value in the vector is ignored.

SetEmotionalEmitter

public SetEmotionalEmitter()
Creates new instance of command SetEmotionalEmitter. Sets the emotional emitter for the bot and configures it. The emitter will float at the bots head following the bot. Corresponding GameBots message for this command is SETEMIT.

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


SetEmotionalEmitter

public SetEmotionalEmitter(SetEmotionalEmitter original)
Cloning constructor.

Parameters:
original -
Method Detail

isDisable

public java.lang.Boolean isDisable()
If true disables actual emittor (it will dissappear). No other attributes will be parsed.


setDisable

public SetEmotionalEmitter setDisable(java.lang.Boolean Disable)
If true disables actual emittor (it will dissappear). No other attributes will be parsed.


isPause

public java.lang.Boolean isPause()
Should pause the emitter, does not work right now.


setPause

public SetEmotionalEmitter setPause(java.lang.Boolean Pause)
Should pause the emitter, does not work right now.


getFirstC

public Vector3d getFirstC()
Starting color of the floating balls.


setFirstC

public SetEmotionalEmitter setFirstC(Vector3d FirstC)
Starting color of the floating balls.


getSecondC

public Vector3d getSecondC()
Finishing color of the floating balls.


setSecondC

public SetEmotionalEmitter setSecondC(Vector3d SecondC)
Finishing color of the floating balls.


getStartVelocity

public Velocity getStartVelocity()
This is relative velocity direction vector that will affect the speed and direction of the balls going out. Default (2,2,2).


setStartVelocity

public SetEmotionalEmitter setStartVelocity(Velocity StartVelocity)
This is relative velocity direction vector that will affect the speed and direction of the balls going out. Default (2,2,2).


getEndVelocity

public Velocity getEndVelocity()
This is relative velocity direction vector that will affect the speed and direction of the balls going in. Default (-10,-10,-10).


setEndVelocity

public SetEmotionalEmitter setEndVelocity(Velocity EndVelocity)
This is relative velocity direction vector that will affect the speed and direction of the balls going in. Default (-10,-10,-10).


getVelocityRange

public java.lang.Double getVelocityRange()
This will affect the speed of the balls. Default -20.


setVelocityRange

public SetEmotionalEmitter setVelocityRange(java.lang.Double VelocityRange)
This will affect the speed of the balls. Default -20.


getSize

public Vector3d getSize()
This will affect the size of the balls. Default (4,4,8).


setSize

public SetEmotionalEmitter setSize(Vector3d Size)
This will affect the size of the balls. Default (4,4,8).


getLifeTime

public java.lang.Double getLifeTime()
This will affect the life time of the balls and radius and speed they will be traversing. Default 1.6.


setLifeTime

public SetEmotionalEmitter setLifeTime(java.lang.Double LifeTime)
This will affect the life time of the balls and radius and speed they will be traversing. Default 1.6.


getFadeTime

public Vector3d getFadeTime()
This will affect the fade in and fade out times of the balls. First value affects the starting fade out time. Second value will affect ending fade in time. The third value in the vector is ignored.


setFadeTime

public SetEmotionalEmitter setFadeTime(Vector3d FadeTime)
This will affect the fade in and fade out times of the balls. First value affects the starting fade out time. Second value will affect ending fade in time. The third value in the vector is ignored.


toString

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

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()