Crossfire JXClient, Trunk  R20561
com.realtime.crossfire.jxclient.settings.SettingsEntries Class Reference

All defined entries in the settings file. More...

+ Collaboration diagram for com.realtime.crossfire.jxclient.settings.SettingsEntries:

Static Public Member Functions

static SettingsEntry< String > getLoginAccountSettingsEntry (@NotNull final String hostname)
 Returns the SettingsEntry for the default account name on a server. More...
 
static SettingsEntry< String > getLoginAccountSettingsEntry (@NotNull final String hostname, @NotNull final String accountName)
 Returns the SettingsEntry for the default character name on an account. More...
 
static SettingsEntry< Long > getPickupSettingsEntry (@NotNull final String hostname, @NotNull final String characterName)
 Returns the SettingsEntry for the default pickup mode of a character. More...
 
static SettingsEntry< String > getPlayerSettingsEntry (@NotNull final String hostname)
 Returns the SettingsEntry for the default character name on a server. More...
 

Static Public Attributes

static final SettingsEntry< Boolean > MESSAGE_LOG_SETTINGS_ENTRY = new SettingsEntry<>("messagelog", false, "Whether to record all text messages into a file.")
 Whether to record of all text messages received from the server. More...
 
static final SettingsEntry< String > SERVER = new SettingsEntry<>("server", "crossfire.metalforge.net", "The server last connected to.")
 The server to which the previous connection was made. More...
 

Private Member Functions

 SettingsEntries ()
 Private constructor to prevent instantiation. More...
 

Detailed Description

All defined entries in the settings file.

Author
Andreas Kirschbaum

Definition at line 31 of file SettingsEntries.java.

Constructor & Destructor Documentation

◆ SettingsEntries()

com.realtime.crossfire.jxclient.settings.SettingsEntries.SettingsEntries ( )
private

Private constructor to prevent instantiation.

Definition at line 48 of file SettingsEntries.java.

Member Function Documentation

◆ getLoginAccountSettingsEntry() [1/2]

static SettingsEntry<String> com.realtime.crossfire.jxclient.settings.SettingsEntries.getLoginAccountSettingsEntry ( @NotNull final String  hostname)
static

Returns the SettingsEntry for the default account name on a server.

Parameters
hostnamethe hostname of the server
Returns
the settings entry

Definition at line 69 of file SettingsEntries.java.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.openDialog(), com.realtime.crossfire.jxclient.window.GuiManager.selectCharacter(), and com.realtime.crossfire.jxclient.window.GuiManager.setAccountName().

+ Here is the caller graph for this function:

◆ getLoginAccountSettingsEntry() [2/2]

static SettingsEntry<String> com.realtime.crossfire.jxclient.settings.SettingsEntries.getLoginAccountSettingsEntry ( @NotNull final String  hostname,
@NotNull final String  accountName 
)
static

Returns the SettingsEntry for the default character name on an account.

Parameters
hostnamethe hostname of the server
accountNamethe name of the account
Returns
the settings entry

Definition at line 81 of file SettingsEntries.java.

◆ getPickupSettingsEntry()

static SettingsEntry<Long> com.realtime.crossfire.jxclient.settings.SettingsEntries.getPickupSettingsEntry ( @NotNull final String  hostname,
@NotNull final String  characterName 
)
static

Returns the SettingsEntry for the default pickup mode of a character.

Parameters
hostnamethe hostname of the server
characterNamethe name of the character
Returns
the settings entry

Definition at line 93 of file SettingsEntries.java.

References com.realtime.crossfire.jxclient.settings.options.Pickup.PU_NOTHING.

Referenced by com.realtime.crossfire.jxclient.window.JXCConnection.setCharacter().

+ Here is the caller graph for this function:

◆ getPlayerSettingsEntry()

static SettingsEntry<String> com.realtime.crossfire.jxclient.settings.SettingsEntries.getPlayerSettingsEntry ( @NotNull final String  hostname)
static

Returns the SettingsEntry for the default character name on a server.

Parameters
hostnamethe hostname of the server
Returns
the settings entry

Definition at line 58 of file SettingsEntries.java.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.openQueryDialog(), and com.realtime.crossfire.jxclient.window.GuiManager.updatePlayerName().

+ Here is the caller graph for this function:

Member Data Documentation

◆ MESSAGE_LOG_SETTINGS_ENTRY

final SettingsEntry<Boolean> com.realtime.crossfire.jxclient.settings.SettingsEntries.MESSAGE_LOG_SETTINGS_ENTRY = new SettingsEntry<>("messagelog", false, "Whether to record all text messages into a file.")
static

Whether to record of all text messages received from the server.

Definition at line 43 of file SettingsEntries.java.

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

◆ SERVER

final SettingsEntry<String> com.realtime.crossfire.jxclient.settings.SettingsEntries.SERVER = new SettingsEntry<>("server", "crossfire.metalforge.net", "The server last connected to.")
static

The server to which the previous connection was made.

Definition at line 37 of file SettingsEntries.java.

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.activateMetaserverGui(), and com.realtime.crossfire.jxclient.window.JXCConnection.setHost().


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