SetDialog (pogamut-ut2004 3.3.1-SNAPSHOT API)

java.lang.Object
- cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
- - 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

Fields
Modifier and Type	Field and Description
`protected 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 String`	`Option0` One of the options (possible answers) for the dialog.
`protected String`	`Option1` One of the options (possible answers) for the dialog.
`protected String`	`Option2` One of the options (possible answers) for the dialog.
`protected String`	`Option3` One of the options (possible answers) for the dialog.
`protected String`	`Option4` One of the options (possible answers) for the dialog.
`protected String`	`Option5` One of the options (possible answers) for the dialog.
`protected String`	`Option6` One of the options (possible answers) for the dialog.
`protected String`	`Option7` One of the options (possible answers) for the dialog.
`protected String`	`Option8` One of the options (possible answers) for the dialog.
`protected String`	`Option9` One of the options (possible answers) for the dialog.
`static String`	`PROTOTYPE` Example how the message looks like - used during parser tests.
`protected String`	`Text` Text of the dialog.

Constructor Summary

Constructors
Constructor and Description
`SetDialog()` Creates new instance of command SetDialog.
`SetDialog(SetDialog original)` Cloning constructor.
`SetDialog(UnrealId Id, String DialogId, String Text, String Option0, String Option1, String Option2, String Option3, String Option4, String Option5, String Option6, String Option7, String Option8, String Option9)` Creates new instance of command SetDialog.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`String`	`getOption0()` One of the options (possible answers) for the dialog.
`String`	`getOption1()` One of the options (possible answers) for the dialog.
`String`	`getOption2()` One of the options (possible answers) for the dialog.
`String`	`getOption3()` One of the options (possible answers) for the dialog.
`String`	`getOption4()` One of the options (possible answers) for the dialog.
`String`	`getOption5()` One of the options (possible answers) for the dialog.
`String`	`getOption6()` One of the options (possible answers) for the dialog.
`String`	`getOption7()` One of the options (possible answers) for the dialog.
`String`	`getOption8()` One of the options (possible answers) for the dialog.
`String`	`getOption9()` One of the options (possible answers) for the dialog.
`String`	`getText()` Text of the dialog.
`SetDialog`	`setDialogId(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(String Option0)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption1(String Option1)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption2(String Option2)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption3(String Option3)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption4(String Option4)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption5(String Option5)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption6(String Option6)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption7(String Option7)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption8(String Option8)` One of the options (possible answers) for the dialog.
`SetDialog`	`setOption9(String Option9)` One of the options (possible answers) for the dialog.
`SetDialog`	`setText(String Text)` Text of the dialog.
`String`	`toHtmlString()`
`String`	`toMessage()`
`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
  - Id
```
protected UnrealId Id
```
    Id of the player we want to set dialog for.
  - DialogId
```
protected 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 String Text
```
    Text of the dialog.
  - Option0
```
protected String Option0
```
    One of the options (possible answers) for the dialog.
  - Option1
```
protected String Option1
```
    One of the options (possible answers) for the dialog.
  - Option2
```
protected String Option2
```
    One of the options (possible answers) for the dialog.
  - Option3
```
protected String Option3
```
    One of the options (possible answers) for the dialog.
  - Option4
```
protected String Option4
```
    One of the options (possible answers) for the dialog.
  - Option5
```
protected String Option5
```
    One of the options (possible answers) for the dialog.
  - Option6
```
protected String Option6
```
    One of the options (possible answers) for the dialog.
  - Option7
```
protected String Option7
```
    One of the options (possible answers) for the dialog.
  - Option8
```
protected String Option8
```
    One of the options (possible answers) for the dialog.
  - Option9
```
protected String Option9
```
    One of the options (possible answers) for the dialog.
- Constructor Detail
  - SetDialog
```
public SetDialog(UnrealId Id,
         String DialogId,
         String Text,
         String Option0,
         String Option1,
         String Option2,
         String Option3,
         String Option4,
         String Option5,
         String Option6,
         String Option7,
         String Option8,
         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 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(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 String getText()
```
    Text of the dialog.
  - setText
```
public SetDialog setText(String Text)
```
    Text of the dialog.
  - getOption0
```
public String getOption0()
```
    One of the options (possible answers) for the dialog.
  - setOption0
```
public SetDialog setOption0(String Option0)
```
    One of the options (possible answers) for the dialog.
  - getOption1
```
public String getOption1()
```
    One of the options (possible answers) for the dialog.
  - setOption1
```
public SetDialog setOption1(String Option1)
```
    One of the options (possible answers) for the dialog.
  - getOption2
```
public String getOption2()
```
    One of the options (possible answers) for the dialog.
  - setOption2
```
public SetDialog setOption2(String Option2)
```
    One of the options (possible answers) for the dialog.
  - getOption3
```
public String getOption3()
```
    One of the options (possible answers) for the dialog.
  - setOption3
```
public SetDialog setOption3(String Option3)
```
    One of the options (possible answers) for the dialog.
  - getOption4
```
public String getOption4()
```
    One of the options (possible answers) for the dialog.
  - setOption4
```
public SetDialog setOption4(String Option4)
```
    One of the options (possible answers) for the dialog.
  - getOption5
```
public String getOption5()
```
    One of the options (possible answers) for the dialog.
  - setOption5
```
public SetDialog setOption5(String Option5)
```
    One of the options (possible answers) for the dialog.
  - getOption6
```
public String getOption6()
```
    One of the options (possible answers) for the dialog.
  - setOption6
```
public SetDialog setOption6(String Option6)
```
    One of the options (possible answers) for the dialog.
  - getOption7
```
public String getOption7()
```
    One of the options (possible answers) for the dialog.
  - setOption7
```
public SetDialog setOption7(String Option7)
```
    One of the options (possible answers) for the dialog.
  - getOption8
```
public String getOption8()
```
    One of the options (possible answers) for the dialog.
  - setOption8
```
public SetDialog setOption8(String Option8)
```
    One of the options (possible answers) for the dialog.
  - getOption9
```
public String getOption9()
```
    One of the options (possible answers) for the dialog.
  - setOption9
```
public SetDialog setOption9(String Option9)
```
    One of the options (possible answers) for the dialog.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class CommandMessage
  - toHtmlString
```
public String toHtmlString()
```
  - toMessage
```
public String toMessage()
```

Class SetDialog

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOTYPE

Id

DialogId

Text

Option0

Option1

Option2

Option3

Option4

Option5

Option6

Option7

Option8

Option9

Constructor Detail

SetDialog

SetDialog

SetDialog

Method Detail

getId

setId

getDialogId

setDialogId

getText

setText

getOption0

setOption0

getOption1

setOption1

getOption2

setOption2

getOption3

setOption3

getOption4

setOption4

getOption5

setOption5

getOption6

setOption6

getOption7

setOption7

getOption8

setOption8

getOption9

setOption9

toString

toHtmlString

toMessage