cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages

Class FactoryUsed

java.lang.Object

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

cz.cuni.amis.pogamut.udk.communication.messages.GBEvent

cz.cuni.amis.pogamut.udk.communication.messages.gbinfomessages.FactoryUsed

All Implemented Interfaces:

IWorldChangeEvent, IWorldEventWrapper, IWorldEvent, IGBWorldEvent, cz.cuni.amis.utils.listener.Event

public class FactoryUsed
extends GBEvent
implements IWorldEvent, IWorldChangeEvent

Asynchronous message. Response to USE (FactoryUse) command. Corresponding GameBots message is USED.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected String	Reason If success is false, the reason why we couldn't use a factory will be here.
protected boolean	Success If we have successfully used the factory.

Constructor Summary

Constructors

Constructor and Description
FactoryUsed() Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).
FactoryUsed(boolean Success, String Reason) Creates new instance of command FactoryUsed.
FactoryUsed(FactoryUsed original) Cloning constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getReason() If success is false, the reason why we couldn't use a factory will be here.
long	getSimTime()
boolean	isSuccess() If we have successfully used the factory.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.udk.communication.messages.GBEvent

getWorldEvent

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

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

Success

protected boolean Success

If we have successfully used the factory.

Reason

protected String Reason

If success is false, the reason why we couldn't use a factory will be here.

Constructor Detail

FactoryUsed

public FactoryUsed(boolean Success,
           String Reason)

Creates new instance of command FactoryUsed. Asynchronous message. Response to USE (FactoryUse) command. Corresponding GameBots message for this command is .

Parameters:

Success - If we have successfully used the factory.

Reason - If success is false, the reason why we couldn't use a factory will be here.

FactoryUsed

public FactoryUsed(FactoryUsed original)

Cloning constructor.

FactoryUsed

public FactoryUsed()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

isSuccess

public boolean isSuccess()

If we have successfully used the factory.

getReason

public String getReason()

If success is false, the reason why we couldn't use a factory will be here.

getSimTime

public long getSimTime()

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Overrides:

getSimTime in class GBEvent

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()