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

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

public class SetDialog
extends CommandMessage

Representation of the GameBots2004 command DIALOG. Sets the dialog for specified player. Dialog will be set just if the player has our bot selected by cursor (ALT+SHIFT and the LeftMouse button). Note that not all of the Option variables have to be set. But they need to be set succesively starting from 0,1,2 etc. They are parsed in this order and first emty Option will terminate parsing.


Field Summary
protected  java.lang.String DialogId
          Our Id of the dialog - we will match this Id in response messages and in PLI messages.
protected  UnrealId Id
          Id of the player we want to set dialog for.
protected  java.lang.String Option0
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option1
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option2
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option3
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option4
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option5
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option6
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option7
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option8
          One of the options (possible answers) for the dialog.
protected  java.lang.String Option9
          One of the options (possible answers) for the dialog.
static java.lang.String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  java.lang.String Text
          Text of the dialog.
 
Constructor Summary
SetDialog()
          Creates new instance of command SetDialog.
SetDialog(SetDialog original)
          Cloning constructor.
SetDialog(UnrealId Id, java.lang.String DialogId, java.lang.String Text, java.lang.String Option0, java.lang.String Option1, java.lang.String Option2, java.lang.String Option3, java.lang.String Option4, java.lang.String Option5, java.lang.String Option6, java.lang.String Option7, java.lang.String Option8, java.lang.String Option9)
          Creates new instance of command SetDialog.
 
Method Summary
 java.lang.String getDialogId()
          Our Id of the dialog - we will match this Id in response messages and in PLI messages.
 UnrealId getId()
          Id of the player we want to set dialog for.
 java.lang.String getOption0()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption1()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption2()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption3()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption4()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption5()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption6()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption7()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption8()
          One of the options (possible answers) for the dialog.
 java.lang.String getOption9()
          One of the options (possible answers) for the dialog.
 java.lang.String getText()
          Text of the dialog.
 SetDialog setDialogId(java.lang.String DialogId)
          Our Id of the dialog - we will match this Id in response messages and in PLI messages.
 SetDialog setId(UnrealId Id)
          Id of the player we want to set dialog for.
 SetDialog setOption0(java.lang.String Option0)
          One of the options (possible answers) for the dialog.
 SetDialog setOption1(java.lang.String Option1)
          One of the options (possible answers) for the dialog.
 SetDialog setOption2(java.lang.String Option2)
          One of the options (possible answers) for the dialog.
 SetDialog setOption3(java.lang.String Option3)
          One of the options (possible answers) for the dialog.
 SetDialog setOption4(java.lang.String Option4)
          One of the options (possible answers) for the dialog.
 SetDialog setOption5(java.lang.String Option5)
          One of the options (possible answers) for the dialog.
 SetDialog setOption6(java.lang.String Option6)
          One of the options (possible answers) for the dialog.
 SetDialog setOption7(java.lang.String Option7)
          One of the options (possible answers) for the dialog.
 SetDialog setOption8(java.lang.String Option8)
          One of the options (possible answers) for the dialog.
 SetDialog setOption9(java.lang.String Option9)
          One of the options (possible answers) for the dialog.
 SetDialog setText(java.lang.String Text)
          Text of the dialog.
 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

Id

protected UnrealId Id
Id of the player we want to set dialog for.


DialogId

protected java.lang.String DialogId
Our Id of the dialog - we will match this Id in response messages and in PLI messages. We choose this value.


Text

protected java.lang.String Text
Text of the dialog.


Option0

protected java.lang.String Option0
One of the options (possible answers) for the dialog.


Option1

protected java.lang.String Option1
One of the options (possible answers) for the dialog.


Option2

protected java.lang.String Option2
One of the options (possible answers) for the dialog.


Option3

protected java.lang.String Option3
One of the options (possible answers) for the dialog.


Option4

protected java.lang.String Option4
One of the options (possible answers) for the dialog.


Option5

protected java.lang.String Option5
One of the options (possible answers) for the dialog.


Option6

protected java.lang.String Option6
One of the options (possible answers) for the dialog.


Option7

protected java.lang.String Option7
One of the options (possible answers) for the dialog.


Option8

protected java.lang.String Option8
One of the options (possible answers) for the dialog.


Option9

protected java.lang.String Option9
One of the options (possible answers) for the dialog.

Constructor Detail

SetDialog

public SetDialog(UnrealId Id,
                 java.lang.String DialogId,
                 java.lang.String Text,
                 java.lang.String Option0,
                 java.lang.String Option1,
                 java.lang.String Option2,
                 java.lang.String Option3,
                 java.lang.String Option4,
                 java.lang.String Option5,
                 java.lang.String Option6,
                 java.lang.String Option7,
                 java.lang.String Option8,
                 java.lang.String Option9)
Creates new instance of command SetDialog. Sets the dialog for specified player. Dialog will be set just if the player has our bot selected by cursor (ALT+SHIFT and the LeftMouse button). Note that not all of the Option variables have to be set. But they need to be set succesively starting from 0,1,2 etc. They are parsed in this order and first emty Option will terminate parsing. Corresponding GameBots message for this command is DIALOG.

Parameters:
Id - Id of the player we want to set dialog for.
DialogId - Our Id of the dialog - we will match this Id in response messages and in PLI messages. We choose this value.
Text - Text of the dialog.
Option0 - One of the options (possible answers) for the dialog.
Option1 - One of the options (possible answers) for the dialog.
Option2 - One of the options (possible answers) for the dialog.
Option3 - One of the options (possible answers) for the dialog.
Option4 - One of the options (possible answers) for the dialog.
Option5 - One of the options (possible answers) for the dialog.
Option6 - One of the options (possible answers) for the dialog.
Option7 - One of the options (possible answers) for the dialog.
Option8 - One of the options (possible answers) for the dialog.
Option9 - One of the options (possible answers) for the dialog.

SetDialog

public SetDialog()
Creates new instance of command SetDialog. Sets the dialog for specified player. Dialog will be set just if the player has our bot selected by cursor (ALT+SHIFT and the LeftMouse button). Note that not all of the Option variables have to be set. But they need to be set succesively starting from 0,1,2 etc. They are parsed in this order and first emty Option will terminate parsing. Corresponding GameBots message for this command is DIALOG.

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


SetDialog

public SetDialog(SetDialog original)
Cloning constructor.

Parameters:
original -
Method Detail

getId

public UnrealId getId()
Id of the player we want to set dialog for.


setId

public SetDialog setId(UnrealId Id)
Id of the player we want to set dialog for.


getDialogId

public java.lang.String getDialogId()
Our Id of the dialog - we will match this Id in response messages and in PLI messages. We choose this value.


setDialogId

public SetDialog setDialogId(java.lang.String DialogId)
Our Id of the dialog - we will match this Id in response messages and in PLI messages. We choose this value.


getText

public java.lang.String getText()
Text of the dialog.


setText

public SetDialog setText(java.lang.String Text)
Text of the dialog.


getOption0

public java.lang.String getOption0()
One of the options (possible answers) for the dialog.


setOption0

public SetDialog setOption0(java.lang.String Option0)
One of the options (possible answers) for the dialog.


getOption1

public java.lang.String getOption1()
One of the options (possible answers) for the dialog.


setOption1

public SetDialog setOption1(java.lang.String Option1)
One of the options (possible answers) for the dialog.


getOption2

public java.lang.String getOption2()
One of the options (possible answers) for the dialog.


setOption2

public SetDialog setOption2(java.lang.String Option2)
One of the options (possible answers) for the dialog.


getOption3

public java.lang.String getOption3()
One of the options (possible answers) for the dialog.


setOption3

public SetDialog setOption3(java.lang.String Option3)
One of the options (possible answers) for the dialog.


getOption4

public java.lang.String getOption4()
One of the options (possible answers) for the dialog.


setOption4

public SetDialog setOption4(java.lang.String Option4)
One of the options (possible answers) for the dialog.


getOption5

public java.lang.String getOption5()
One of the options (possible answers) for the dialog.


setOption5

public SetDialog setOption5(java.lang.String Option5)
One of the options (possible answers) for the dialog.


getOption6

public java.lang.String getOption6()
One of the options (possible answers) for the dialog.


setOption6

public SetDialog setOption6(java.lang.String Option6)
One of the options (possible answers) for the dialog.


getOption7

public java.lang.String getOption7()
One of the options (possible answers) for the dialog.


setOption7

public SetDialog setOption7(java.lang.String Option7)
One of the options (possible answers) for the dialog.


getOption8

public java.lang.String getOption8()
One of the options (possible answers) for the dialog.


setOption8

public SetDialog setOption8(java.lang.String Option8)
One of the options (possible answers) for the dialog.


getOption9

public java.lang.String getOption9()
One of the options (possible answers) for the dialog.


setOption9

public SetDialog setOption9(java.lang.String Option9)
One of the options (possible answers) for the dialog.


toString

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

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()