net.sf.freecol
Class FreeCol

java.lang.Object
  net.sf.freecol.FreeCol

public final class FreeCol
extends java.lang.Object

This class is responsible for handling the command-line arguments and starting either the stand-alone server or the client-GUI.

See Also:

FreeColClient, FreeColServer

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LICENSE
static java.lang.String	META_SERVER_ADDRESS
static int	META_SERVER_PORT
static java.lang.String	REVISION
static Specification	specification

Method Summary

static java.io.File	getAutosaveDirectory() Returns the directory where the autogenerated savegames should be put.
static java.io.File	getSaveDirectory() Returns the directory where the savegames should be put.
static java.lang.String	getVersion() Gets the current version of game.
static boolean	isInDebugMode() Checks if the program is in "Debug mode".
static void	main(java.lang.String[] args) The entrypoint.
static void	setInDebugMode(boolean debug) Sets the "debug mode" to be active or not.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

specification

public static final Specification specification

META_SERVER_ADDRESS

public static final java.lang.String META_SERVER_ADDRESS

See Also:

Constant Field Values

META_SERVER_PORT

public static final int META_SERVER_PORT

See Also:

Constant Field Values

Method Detail

main

public static void main(java.lang.String[] args)

The entrypoint.

Parameters:

args - The command-line arguments.

getSaveDirectory

public static java.io.File getSaveDirectory()

Returns the directory where the savegames should be put.

Returns:

The directory where the savegames should be put.

getAutosaveDirectory

public static java.io.File getAutosaveDirectory()

Returns the directory where the autogenerated savegames should be put.

Returns:

The directory.

getVersion

public static java.lang.String getVersion()

Gets the current version of game.

Returns:

The current version of the game using the format "x.y.z", where "x" is major, "y" is minor and "z" is revision.

isInDebugMode

public static boolean isInDebugMode()

Checks if the program is in "Debug mode".

Returns:

true if the program is in debug mode and false otherwise.

setInDebugMode

public static void setInDebugMode(boolean debug)

Sets the "debug mode" to be active or not.

Parameters:

debug - Should be true in order to active debug mode and false otherwise.