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

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

public class Pause
extends CommandMessage

Representation of the GameBots2004 command PAUSE. Will pause/unpause the game. The game can be paused just if bAllowPause = true in GameBots2004.ini (different settings for bots and server possible).

Field Summary

protected java.lang.Boolean	PauseAll Everyone in the game will be paused if set to true.
protected java.lang.Boolean	PauseBots Iif true only bots will be paused – players and spectators will move freely.
static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.

Constructor Summary

Pause()
Creates new instance of command Pause.

Pause(java.lang.Boolean PauseBots, java.lang.Boolean PauseAll)
Creates new instance of command Pause.

Pause(Pause original)
Cloning constructor.

Method Summary

java.lang.Boolean	isPauseAll() Everyone in the game will be paused if set to true.
java.lang.Boolean	isPauseBots() Iif true only bots will be paused – players and spectators will move freely.
Pause	setPauseAll(java.lang.Boolean PauseAll) Everyone in the game will be paused if set to true.
Pause	setPauseBots(java.lang.Boolean PauseBots) Iif true only bots will be paused – players and spectators will move freely.
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

PauseBots

protected java.lang.Boolean PauseBots

Iif true only bots will be paused – players and spectators will move freely.

PauseAll

protected java.lang.Boolean PauseAll

Everyone in the game will be paused if set to true. To unpause send PAUSE command with PauseAll set to false.

Constructor Detail

Pause

public Pause(java.lang.Boolean PauseBots,
             java.lang.Boolean PauseAll)

Creates new instance of command Pause. Will pause/unpause the game. The game can be paused just if bAllowPause = true in GameBots2004.ini (different settings for bots and server possible). Corresponding GameBots message for this command is PAUSE.

Parameters:

PauseBots - Iif true only bots will be paused – players and spectators will move freely.

PauseAll - Everyone in the game will be paused if set to true. To unpause send PAUSE command with PauseAll set to false.

Pause

public Pause()

Creates new instance of command Pause. Will pause/unpause the game. The game can be paused just if bAllowPause = true in GameBots2004.ini (different settings for bots and server possible). Corresponding GameBots message for this command is PAUSE.

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

Pause

public Pause(Pause original)

Cloning constructor.

Parameters:

original -

Method Detail

isPauseBots

public java.lang.Boolean isPauseBots()

Iif true only bots will be paused – players and spectators will move freely.

setPauseBots

public Pause setPauseBots(java.lang.Boolean PauseBots)

Iif true only bots will be paused – players and spectators will move freely.

isPauseAll

public java.lang.Boolean isPauseAll()

Everyone in the game will be paused if set to true. To unpause send PAUSE command with PauseAll set to false.

setPauseAll

public Pause setPauseAll(java.lang.Boolean PauseAll)

Everyone in the game will be paused if set to true. To unpause send PAUSE command with PauseAll set to false.

toString

public java.lang.String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public java.lang.String toHtmlString()

toMessage

public java.lang.String toMessage()