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

Public Member Functions
String	getDebugKeyboardFilename ()

String	getDebugMouseFilename ()

String	getDebugProtocolFilename ()

String	getDebugScreenFilename ()

String	getDebugSoundFilename ()

float	getFontScaleFactor ()

Resolution	getResolution ()

String	getServer ()

String	getSkin ()

int	getTileSize ()

boolean	isAvoidCopyArea ()

boolean	isDebugGui ()

boolean	isFullScreen ()

void	parse (@NotNull final String @NotNull[] args)

Static Public Attributes
static final String	DEFAULT_SKIN = "ragnorok"

Private Attributes
boolean	avoidCopyArea

boolean	debugGui

String	debugKeyboardFilename

String	debugMouseFilename

String	debugProtocolFilename

String	debugScreenFilename

String	debugSoundFilename

float	fontScaleFactor = 1.0F

boolean	fullScreen

Resolution	resolution

String	server

String	skin = DEFAULT_SKIN

int	tileSize = DEFAULT_TILE_SIZE

Static Private Attributes
static final int	DEFAULT_TILE_SIZE = 64

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 248 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 257 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 239 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 266 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 275 of file Options.java.

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

◆ getFontScaleFactor()

float com.realtime.crossfire.jxclient.main.Options.getFontScaleFactor ( )

Returns the font scale factor.

Returns: the factor

Definition at line 317 of file Options.java.

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

◆ getResolution()

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

Returns the resolution.

Returns: the resolution or
null

for default

Definition at line 292 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 334 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

Definition at line 301 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 309 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 343 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 283 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 325 of file Options.java.

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

◆ parse()

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

Parse command line arguments.

Parameters

args	the command line arguments

Definition at line 130 of file Options.java.

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 124 of file Options.java.

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

◆ debugGui

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

private

Enable debugging of GUI elements.

Definition at line 56 of file Options.java.

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

◆ 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 70 of file Options.java.

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

◆ 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 77 of file Options.java.

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

◆ 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 63 of file Options.java.

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

◆ 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 84 of file Options.java.

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

◆ 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 90 of file Options.java.

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

◆ DEFAULT_SKIN

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

static

The default skin name.

Definition at line 118 of file Options.java.

Referenced by com.realtime.crossfire.jxclient.main.JXClient.JXClient(), 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.

◆ fontScaleFactor

float com.realtime.crossfire.jxclient.main.Options.fontScaleFactor = 1.0F

private

The scale factor for font sizes.

Definition at line 112 of file Options.java.

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

◆ fullScreen

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

private

Whether full-screen mode should be enabled.

Definition at line 44 of file Options.java.

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

◆ resolution

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

private

The resolution to use or

null

for default.

Definition at line 96 of file Options.java.

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

◆ 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 51 of file Options.java.

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

◆ skin

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

private

The skin name to load.

Definition at line 102 of file Options.java.

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

◆ 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 107 of file Options.java.

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

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

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()

◆ getFontScaleFactor()

◆ getResolution()

◆ getServer()

◆ getSkin()

◆ getTileSize()

◆ isAvoidCopyArea()

◆ isDebugGui()

◆ isFullScreen()

◆ parse()

Member Data Documentation

◆ avoidCopyArea

◆ debugGui

◆ debugKeyboardFilename

◆ debugMouseFilename

◆ debugProtocolFilename

◆ debugScreenFilename

◆ debugSoundFilename

◆ DEFAULT_SKIN

◆ DEFAULT_TILE_SIZE

◆ fontScaleFactor

◆ fullScreen

◆ resolution

◆ server

◆ skin

◆ tileSize