cz.cuni.amis.pogamut.ut2004.utils
Class UCCWrapperConf

java.lang.Object
  cz.cuni.amis.pogamut.ut2004.utils.UCCWrapperConf

All Implemented Interfaces:

Serializable

public class UCCWrapperConf
extends Object
implements Serializable

Configuration object of the UCC wrapper instance.

See Also:

Serialized Form

Field Summary

protected String	gameBotsPack
protected String	gameType
protected String	mapName
protected String	mutators
protected String	options
protected UCCWrapperPatterns	patterns
protected int	playerPort Port for human player - UT2004 client uses this port to connect to the server.
protected boolean	startOnUnusedPort
protected String	unrealHome

Constructor Summary

UCCWrapperConf()

UCCWrapperConf(UCCWrapperConf uccConf)

Method Summary

String	getGameBotsPack()
String	getGameType()
Logger	getLog()
String	getMapName()
String	getMutators()
String	getOptions()
UCCWrapperPatterns	getPatterns() Sets patterns that recognizes UCC output for successful startup.
int	getPlayerPort() Returns the port for human player - UT2004 client uses this port to connect to the server.
String	getUnrealHome() Returns Pogamut.getPlatform().getProperty(PogamutUT2004Property.POGAMUT_UNREAL_HOME) if not specified.
boolean	isStartOnUnusedPort()
UCCWrapperConf	setGameBotsPack(String gameBotsPack) Eg.
UCCWrapperConf	setGameType(String gameType) Eg.
void	setLog(Logger log)
UCCWrapperConf	setLogger(Logger log) Logger used by the UCC.
UCCWrapperConf	setMapName(String mapName)
void	setMutators(String mutators)
UCCWrapperConf	setOptions(String options) Can be used for setting mutators etc.
void	setPatterns(UCCWrapperPatterns patterns) Sets patterns that recognizes UCC output for successful startup.
void	setPlayerPort(int playerPort) Sets the port for human player - UT2004 client uses this port to connect to the server.
UCCWrapperConf	setStartOnUnusedPort(boolean startOnUnusedPort) Forces UCC to find free port and start on it, otherwise it will start on ports 3000 + 3001.
void	setUnrealHome(String unrealHome) Sets path to the UT2004 directory, e.g., 'd:\\games\\ut2004'.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

patterns

protected UCCWrapperPatterns patterns

unrealHome

protected String unrealHome

mapName

protected String mapName

gameBotsPack

protected String gameBotsPack

gameType

protected String gameType

mutators

protected String mutators

options

protected String options

playerPort

protected int playerPort

Port for human player - UT2004 client uses this port to connect to the server.

startOnUnusedPort

protected boolean startOnUnusedPort

Constructor Detail

UCCWrapperConf

public UCCWrapperConf()

UCCWrapperConf

public UCCWrapperConf(UCCWrapperConf uccConf)

Method Detail

getPlayerPort

public int getPlayerPort()

Returns the port for human player - UT2004 client uses this port to connect to the server.

setPlayerPort

public void setPlayerPort(int playerPort)

Sets the port for human player - UT2004 client uses this port to connect to the server.

toString

public String toString()

Overrides:

toString in class Object

getPatterns

public UCCWrapperPatterns getPatterns()

Sets patterns that recognizes UCC output for successful startup.

Returns:

setPatterns

public void setPatterns(UCCWrapperPatterns patterns)

Sets patterns that recognizes UCC output for successful startup.

Parameters:

patterns -

getUnrealHome

public String getUnrealHome()

Returns Pogamut.getPlatform().getProperty(PogamutUT2004Property.POGAMUT_UNREAL_HOME) if not specified.

Returns:

setUnrealHome

public void setUnrealHome(String unrealHome)

Sets path to the UT2004 directory, e.g., 'd:\\games\\ut2004'.

Should not need to be set if provided via property file.

Parameters:

unrealHome -

setStartOnUnusedPort

public UCCWrapperConf setStartOnUnusedPort(boolean startOnUnusedPort)

Forces UCC to find free port and start on it, otherwise it will start on ports 3000 + 3001.

Parameters:

startOnUnusedPort -

setGameBotsPack

public UCCWrapperConf setGameBotsPack(String gameBotsPack)

Eg. GameBots2004, GBSceanrio etc.

Parameters:

gameBotsPack -

setMapName

public UCCWrapperConf setMapName(String mapName)

setGameType

public UCCWrapperConf setGameType(String gameType)

Eg. BotDeathMatch, BotCTFGame etc. Consult GameBots documentation for complete list available game types.

setOptions

public UCCWrapperConf setOptions(String options)

Can be used for setting mutators etc.

Parameters:

options -

setLogger

public UCCWrapperConf setLogger(Logger log)

Logger used by the UCC.

Parameters:

log -

getMutators

public String getMutators()

setMutators

public void setMutators(String mutators)

getLog

public Logger getLog()

setLog

public void setLog(Logger log)

getMapName

public String getMapName()

getGameBotsPack

public String getGameBotsPack()

getGameType

public String getGameType()

getOptions

public String getOptions()

isStartOnUnusedPort

public boolean isStartOnUnusedPort()