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

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

public class SendMessage
extends CommandMessage

Representation of the GameBots2004 command MESSAGE. Send a message to the world or just your team.

Field Summary

protected java.lang.Double	FadeOut Enables text bubble.
protected java.lang.Boolean	Global If True it is sent to everyone.
protected UnrealId	Id Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message).
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected java.lang.String	Text Text to send.

Constructor Summary

SendMessage()
Creates new instance of command SendMessage.

SendMessage(SendMessage original)
Cloning constructor.

SendMessage(UnrealId Id, java.lang.String Text, java.lang.Boolean Global, java.lang.Double FadeOut)
Creates new instance of command SendMessage.

Method Summary

java.lang.Double	getFadeOut() Enables text bubble.
UnrealId	getId() Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message).
java.lang.String	getText() Text to send.
java.lang.Boolean	isGlobal() If True it is sent to everyone.
SendMessage	setFadeOut(java.lang.Double FadeOut) Enables text bubble.
SendMessage	setGlobal(java.lang.Boolean Global) If True it is sent to everyone.
SendMessage	setId(UnrealId Id) Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message).
SendMessage	setText(java.lang.String Text) Text to send.
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

Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message). Doesn't work for players (but if text bubble enabled, players will see this message above the bot head).

Text

protected java.lang.String Text

Text to send.

Global

protected java.lang.Boolean Global

If True it is sent to everyone. Otherwise (or if not specified), just your team.

FadeOut

protected java.lang.Double FadeOut

Enables text bubble. Sets how long the bubble should stay (in seconds, counted ~ 12 + FadeOut seconds - dunno why, some UT mechanics?). If -1 the bubble won't be shown.

Constructor Detail

SendMessage

public SendMessage(UnrealId Id,
                   java.lang.String Text,
                   java.lang.Boolean Global,
                   java.lang.Double FadeOut)

Creates new instance of command SendMessage. Send a message to the world or just your team. Corresponding GameBots message for this command is MESSAGE.

Parameters:

Id - Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message). Doesn't work for players (but if text bubble enabled, players will see this message above the bot head).

Text - Text to send.

Global - If True it is sent to everyone. Otherwise (or if not specified), just your team.

FadeOut - Enables text bubble. Sets how long the bubble should stay (in seconds, counted ~ 12 + FadeOut seconds - dunno why, some UT mechanics?). If -1 the bubble won't be shown.

SendMessage

public SendMessage()

Creates new instance of command SendMessage. Send a message to the world or just your team. Corresponding GameBots message for this command is MESSAGE.

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

SendMessage

public SendMessage(SendMessage original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public UnrealId getId()

Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message). Doesn't work for players (but if text bubble enabled, players will see this message above the bot head).

setId

public SendMessage setId(UnrealId Id)

Here we can specify Id of the bot, that will receive this message privately (with "Private:" string at the beginning of the message). Doesn't work for players (but if text bubble enabled, players will see this message above the bot head).

getText

public java.lang.String getText()

Text to send.

setText

public SendMessage setText(java.lang.String Text)

Text to send.

isGlobal

public java.lang.Boolean isGlobal()

If True it is sent to everyone. Otherwise (or if not specified), just your team.

setGlobal

public SendMessage setGlobal(java.lang.Boolean Global)

If True it is sent to everyone. Otherwise (or if not specified), just your team.

getFadeOut

public java.lang.Double getFadeOut()

Enables text bubble. Sets how long the bubble should stay (in seconds, counted ~ 12 + FadeOut seconds - dunno why, some UT mechanics?). If -1 the bubble won't be shown.

setFadeOut

public SendMessage setFadeOut(java.lang.Double FadeOut)

Enables text bubble. Sets how long the bubble should stay (in seconds, counted ~ 12 + FadeOut seconds - dunno why, some UT mechanics?). If -1 the bubble won't be shown.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()