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

Class Kick

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.CommandMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands.Kick

public class Kick
extends CommandMessage

Representation of the GameBots2004 command KICK. Will kick GameBots Bot from the server.

Field Summary

Fields

Modifier and Type	Field and Description
protected UnrealId	Id Id of the bot to be kicked.
static String	PROTOTYPE Example how the message looks like - used during parser tests.

Constructor Summary

Constructors

Constructor and Description
Kick() Creates new instance of command Kick.
Kick(Kick original) Cloning constructor.
Kick(UnrealId Id) Creates new instance of command Kick.

Method Summary

Methods

Modifier and Type	Method and Description
UnrealId	getId() Id of the bot to be kicked.
Kick	setId(UnrealId Id) Id of the bot to be kicked.
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 bot to be kicked.

Constructor Detail

Kick

public Kick(UnrealId Id)

Creates new instance of command Kick. Will kick GameBots Bot from the server. Corresponding GameBots message for this command is KICK.

Parameters:

Id - Id of the bot to be kicked.

Kick

public Kick()

Creates new instance of command Kick. Will kick GameBots Bot from the server. Corresponding GameBots message for this command is KICK.

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

Kick

public Kick(Kick original)

Cloning constructor.

Parameters:

original -

Method Detail

getId

public UnrealId getId()

Id of the bot to be kicked.

setId

public Kick setId(UnrealId Id)

Id of the bot to be kicked.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()