Command line argument parser. More...

Collaboration diagram for com.realtime.crossfire.jxclient.main.Options:

Public Member Functions
String	getDebugKeyboardFilename ()
	Returns the filename for keyboard debug logs. More...

String	getDebugMouseFilename ()
	Returns the filename for mouse debug logs. More...

String	getDebugProtocolFilename ()
	Returns the filename for Crossfire protocol debug logs. More...

String	getDebugScreenFilename ()
	Returns the filename for screen debug logs. More...

String	getDebugSoundFilename ()
	Returns the filename for sound debug logs. More...

Resolution	getResolution ()
	Returns the resolution. More...

String	getServer ()
	Returns the Crossfire server to connect to. More...

String	getSkin ()
	Returns the skin name. More...

int	getTileSize ()
	Returns the size of a tile in the map view. More...

boolean	isAvoidCopyArea ()
	Returns whether map scrolling is done by copying pixel areas. More...

boolean	isDebugGui ()
	Returns whether debugging of GUI elements is enabled. More...

boolean	isFullScreen ()
	Returns whether full-screen mode should be enabled. More...

void	parse (@NotNull final String[] args)
	Parse command line arguments. More...

Static Public Attributes
static final String	DEFAULT_SKIN = "ragnorok"
	The default skin name. More...

Private Attributes
boolean	avoidCopyArea
	Whether map scrolling is done by copying pixel areas. More...

boolean	debugGui
	Enable debugging of GUI elements. More...

String	debugKeyboardFilename
	The filename for keyboard debug logs or. More...

String	debugMouseFilename
	The filename for mouse debug logs or. More...

String	debugProtocolFilename
	The filename for Crossfire protocol message logs or. More...

String	debugScreenFilename
	The filename for screen debug logs or. More...

String	debugSoundFilename
	The filename for sound debug logs or. More...

boolean	fullScreen = true
	The Settings for saving/restoring defaults. More...

Resolution	resolution
	The resolution to use or. More...

String	server
	The Crossfire server to connect to or. More...

String	skin
	The skin name to load or. More...

int	tileSize = DEFAULT_TILE_SIZE
	The size of tiles in the map view in pixels. More...

Static Private Attributes
static final int	DEFAULT_TILE_SIZE = 64
	The default size of tiles in the map view in pixels. More...

Detailed Description

Command line argument parser.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 34 of file Options.java.

Member Function Documentation

◆ getDebugKeyboardFilename()

String com.realtime.crossfire.jxclient.main.Options.getDebugKeyboardFilename ( )

Returns the filename for keyboard debug logs.

Returns: the filename or
null
to not log keyboard input

Definition at line 242 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugKeyboardFilename.

◆ getDebugMouseFilename()

String com.realtime.crossfire.jxclient.main.Options.getDebugMouseFilename ( )

Returns the filename for mouse debug logs.

Returns: the filename or
null
to not log mouse input

Definition at line 251 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugMouseFilename.

◆ getDebugProtocolFilename()

String com.realtime.crossfire.jxclient.main.Options.getDebugProtocolFilename ( )

Returns the filename for Crossfire protocol debug logs.

Returns: the filename or
null
to not log Crossfire protocol messages

Definition at line 233 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugProtocolFilename.

◆ getDebugScreenFilename()

String com.realtime.crossfire.jxclient.main.Options.getDebugScreenFilename ( )

Returns the filename for screen debug logs.

Returns: the filename or
null
to not log screen logs

Definition at line 260 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugScreenFilename.

◆ getDebugSoundFilename()

String com.realtime.crossfire.jxclient.main.Options.getDebugSoundFilename ( )

Returns the filename for sound debug logs.

Returns: the filename or
null
to not log sound logs

Definition at line 269 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugSoundFilename.

◆ getResolution()

Resolution com.realtime.crossfire.jxclient.main.Options.getResolution ( )

Returns the resolution.

Returns: the resolution or
null
for default

Definition at line 286 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.resolution.

◆ getServer()

String com.realtime.crossfire.jxclient.main.Options.getServer ( )

Returns the Crossfire server to connect to.

Returns: the server or
null
for interactive server selection

Definition at line 320 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.server.

◆ getSkin()

String com.realtime.crossfire.jxclient.main.Options.getSkin ( )

Returns the skin name.

Returns: the skin name or
null
for the default skin

Definition at line 295 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.skin.

◆ getTileSize()

int com.realtime.crossfire.jxclient.main.Options.getTileSize ( )

Returns the size of a tile in the map view.

Returns: the tile size in pixels

Definition at line 303 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.tileSize.

◆ isAvoidCopyArea()

boolean com.realtime.crossfire.jxclient.main.Options.isAvoidCopyArea ( )

Returns whether map scrolling is done by copying pixel areas.

If unset, always repaint all map squares.

Returns: whether copying pixel areas is disallowed

Definition at line 329 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.avoidCopyArea.

◆ isDebugGui()

boolean com.realtime.crossfire.jxclient.main.Options.isDebugGui ( )

Returns whether debugging of GUI elements is enabled.

Returns: whether debugging of GUI elements is enabled

Definition at line 277 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.debugGui.

◆ isFullScreen()

boolean com.realtime.crossfire.jxclient.main.Options.isFullScreen ( )

Returns whether full-screen mode should be enabled.

Returns: whether full-screen mode should be enabled

Definition at line 311 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.fullScreen.

◆ parse()

void com.realtime.crossfire.jxclient.main.Options.parse ( @NotNull final String [] args )

Parse command line arguments.

Parameters

args	the command line arguments

Definition at line 129 of file Options.java.

References com.realtime.crossfire.jxclient.main.Options.DEFAULT_SKIN, and com.realtime.crossfire.jxclient.util.Resolution.parse().

Referenced by com.realtime.crossfire.jxclient.main.JXClient.main().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ avoidCopyArea

boolean com.realtime.crossfire.jxclient.main.Options.avoidCopyArea

private

Whether map scrolling is done by copying pixel areas.

If unset, always repaint all map squares.

Definition at line 123 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.isAvoidCopyArea().

◆ debugGui

boolean com.realtime.crossfire.jxclient.main.Options.debugGui

private

Enable debugging of GUI elements.

Definition at line 60 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.isDebugGui().

◆ debugKeyboardFilename

String com.realtime.crossfire.jxclient.main.Options.debugKeyboardFilename

private

The filename for keyboard debug logs or.

null

to not log keyboard input.

Definition at line 74 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getDebugKeyboardFilename().

◆ debugMouseFilename

String com.realtime.crossfire.jxclient.main.Options.debugMouseFilename

private

The filename for mouse debug logs or.

null

to not log mouse input.

Definition at line 81 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getDebugMouseFilename().

◆ debugProtocolFilename

String com.realtime.crossfire.jxclient.main.Options.debugProtocolFilename

private

The filename for Crossfire protocol message logs or.

null

to not log protocol messages.

Definition at line 67 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getDebugProtocolFilename().

◆ debugScreenFilename

String com.realtime.crossfire.jxclient.main.Options.debugScreenFilename

private

The filename for screen debug logs or.

null

to not log screen logs.

Definition at line 88 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getDebugScreenFilename().

◆ debugSoundFilename

String com.realtime.crossfire.jxclient.main.Options.debugSoundFilename

private

The filename for sound debug logs or.

null

to not log sound logs.

Definition at line 94 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getDebugSoundFilename().

◆ DEFAULT_SKIN

final String com.realtime.crossfire.jxclient.main.Options.DEFAULT_SKIN = "ragnorok"

static

The default skin name.

Definition at line 117 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.JXCWindow.init(), and com.realtime.crossfire.jxclient.main.Options.parse().

◆ DEFAULT_TILE_SIZE

final int com.realtime.crossfire.jxclient.main.Options.DEFAULT_TILE_SIZE = 64

staticprivate

The default size of tiles in the map view in pixels.

Definition at line 39 of file Options.java.

◆ fullScreen

boolean com.realtime.crossfire.jxclient.main.Options.fullScreen = true

private

The Settings for saving/restoring defaults.

Whether full-screen mode should be enabled.

Definition at line 48 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.isFullScreen().

◆ resolution

Resolution com.realtime.crossfire.jxclient.main.Options.resolution

private

The resolution to use or.

null

for default.

Definition at line 100 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getResolution().

◆ server

String com.realtime.crossfire.jxclient.main.Options.server

private

The Crossfire server to connect to or.

null

to show the server selections screen.

Definition at line 55 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getServer().

◆ skin

String com.realtime.crossfire.jxclient.main.Options.skin

private

The skin name to load or.

null

for the default skin.

Definition at line 106 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getSkin().

◆ tileSize

int com.realtime.crossfire.jxclient.main.Options.tileSize = DEFAULT_TILE_SIZE

private

The size of tiles in the map view in pixels.

Definition at line 111 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.Options.getTileSize().

The documentation for this class was generated from the following file:

crossfire-code/jxclient/trunk/src/gui/src/main/java/com/realtime/crossfire/jxclient/main/Options.java

Public Member Functions

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ getDebugKeyboardFilename()

◆ getDebugMouseFilename()

◆ getDebugProtocolFilename()

◆ getDebugScreenFilename()

◆ getDebugSoundFilename()

◆ getResolution()

◆ getServer()

◆ getSkin()

◆ getTileSize()

◆ isAvoidCopyArea()

◆ isDebugGui()

◆ isFullScreen()

◆ parse()

Member Data Documentation

◆ avoidCopyArea

◆ debugGui

◆ debugKeyboardFilename

◆ debugMouseFilename

◆ debugProtocolFilename

◆ debugScreenFilename

◆ debugSoundFilename

◆ DEFAULT_SKIN

◆ DEFAULT_TILE_SIZE

◆ fullScreen

◆ resolution

◆ server

◆ skin

◆ tileSize