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

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.CommandMessage
      cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.DialogCancel

public class DialogCancel
extends CommandMessage

Representation of the GameBots2004 command DLGCANCEL. Cancels some dialog, hiding him from screen. The dialog sends DLGCMD with Command CANCEL and latest available data as confirmation.

Field Summary

protected java.lang.String	Id Id of the cancelled dialog.
protected java.lang.String	Player Name of the player on who's HUD is the dialog.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.

Constructor Summary

DialogCancel()
Creates new instance of command DialogCancel.

DialogCancel(DialogCancel original)
Cloning constructor.

DialogCancel(java.lang.String Player, java.lang.String Id)
Creates new instance of command DialogCancel.

Method Summary

java.lang.String	getId() Id of the cancelled dialog.
java.lang.String	getPlayer() Name of the player on who's HUD is the dialog.
DialogCancel	setId(java.lang.String Id) Id of the cancelled dialog.
DialogCancel	setPlayer(java.lang.String Player) Name of the player on who's HUD is 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

Player

protected java.lang.String Player

Name of the player on who's HUD is the dialog.

Id

protected java.lang.String Id

Id of the cancelled dialog.

Constructor Detail

DialogCancel

public DialogCancel(java.lang.String Player,
                    java.lang.String Id)

Creates new instance of command DialogCancel. Cancels some dialog, hiding him from screen. The dialog sends DLGCMD with Command CANCEL and latest available data as confirmation. Corresponding GameBots message for this command is DLGCANCEL.

Parameters:

Player - Name of the player on who's HUD is the dialog.

Id - Id of the cancelled dialog.

DialogCancel

public DialogCancel()

Creates new instance of command DialogCancel. Cancels some dialog, hiding him from screen. The dialog sends DLGCMD with Command CANCEL and latest available data as confirmation. Corresponding GameBots message for this command is DLGCANCEL.

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

DialogCancel

public DialogCancel(DialogCancel original)

Cloning constructor.

Parameters:

original -

Method Detail

getPlayer

public java.lang.String getPlayer()

Name of the player on who's HUD is the dialog.

setPlayer

public DialogCancel setPlayer(java.lang.String Player)

Name of the player on who's HUD is the dialog.

getId

public java.lang.String getId()

Id of the cancelled dialog.

setId

public DialogCancel setId(java.lang.String Id)

Id of the cancelled dialog.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()