com.fs.starfarer.api.impl

Class SharedSettings

java.lang.Object

com.fs.starfarer.api.impl.SharedSettings

public class SharedSettings
extends java.lang.Object

Generally meant for UI settings that are shared across multiple campaigns. "Was this checkbox checked last time this dialog was closed", etc. In some cases that should be tracked per-campaign, but in some cases it makes sense for this to be shared. The amount of data stored here should be small and bounded (i.e. not growing indefinitely). Code using this should assume the data stored here may be lost (e.g. due to the common folder being deleted) and handle this/recover gracefully.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.json.JSONObject	json
static java.lang.String	SETTINGS_DATA_FILE

Constructor Summary

Constructors

Constructor and Description
SharedSettings()

Method Summary

Modifier and Type	Method and Description
static org.json.JSONObject	get()
static void	loadIfNeeded()
static boolean	optBoolean(java.lang.String key, boolean defaultValue)
static float	optFloat(java.lang.String key, float defaultValue)
static int	optInt(java.lang.String key, int defaultValue)
static java.lang.String	optString(java.lang.String key, java.lang.String defaultValue)
static void	saveIfNeeded()
static void	setBoolean(java.lang.String key, boolean value)
static void	setFloat(java.lang.String key, float value)
static void	setInt(java.lang.String key, int value)
static void	setString(java.lang.String key, java.lang.String value)
static void	unset(java.lang.String key)

Methods inherited from class java.lang.Object

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

Field Detail

SETTINGS_DATA_FILE

public static java.lang.String SETTINGS_DATA_FILE

json

protected static org.json.JSONObject json

Constructor Detail

SharedSettings

public SharedSettings()

Method Detail

loadIfNeeded

public static void loadIfNeeded()

saveIfNeeded

public static void saveIfNeeded()

get

public static org.json.JSONObject get()

optBoolean

public static boolean optBoolean(java.lang.String key,
                                 boolean defaultValue)

setBoolean

public static void setBoolean(java.lang.String key,
                              boolean value)

optFloat

public static float optFloat(java.lang.String key,
                             float defaultValue)

setFloat

public static void setFloat(java.lang.String key,
                            float value)

optInt

public static int optInt(java.lang.String key,
                         int defaultValue)

setInt

public static void setInt(java.lang.String key,
                          int value)

optString

public static java.lang.String optString(java.lang.String key,
                                         java.lang.String defaultValue)

setString

public static void setString(java.lang.String key,
                             java.lang.String value)

unset

public static void unset(java.lang.String key)