pl.isangeles.senlin.util

Class Settings

java.lang.Object

pl.isangeles.senlin.util.Settings

public final class Settings
extends java.lang.Object

Static class giving access to external settings file

Author:

Isangeles

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCREENSHOTS_DIR

Method Summary

Modifier and Type	Method and Description
static float	getEffectsVol() Returns audio effects volume level
static java.lang.String	getFowType() Returns current fog of war type
static java.lang.String[]	getFowTypes() Returns array string with fog of war options
static java.lang.String	getLang() Returns language ID
static java.lang.String[]	getLangList() Returns array string with language options
static java.lang.String	getMapRenderType() Returns current map rendering type
static java.lang.String[]	getMapRenderTypes() Returns array with map rendering types
static java.lang.String	getModuleName() Returns game module name
static float	getMusicVol() Returns music volume level
static java.lang.String[]	getResList() Returns array string with all available resolutions
static float[]	getResolution() Returns resolution width and height
static float	getScale() Returns scale for current resolution
static Size	getSystemResolution() Returns current system resolution
static boolean	isHwCursor() Checks if hardware cursor is set
static boolean	saveSettings() Saves current settings to settings file
static void	setEffectsVol(float volLevel) Sets effects volume level
static void	setFowType(java.lang.String fowTypeId) Sets type of fog of war
static void	setHwCursor(boolean hwCursor) Enables or disables hardware cursor
static void	setLang(java.lang.String langId) Sets specified language with specified ID as game language
static void	setMapRenderType(java.lang.String mRenderType) Sets map rendering type
static void	setMusicVol(float volLevel) Sets music volume level
static void	setResolution(Size resolution) Sets specified size as game resolution(needs game restart)

Methods inherited from class java.lang.Object

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

Field Detail

SCREENSHOTS_DIR

public static final java.lang.String SCREENSHOTS_DIR

See Also:

Constant Field Values

Method Detail

getLang

public static java.lang.String getLang()

Returns language ID

Returns:

String with language ID

getResolution

public static float[] getResolution()

Returns resolution width and height

Returns:

Table with width[0] and height[1]

getSystemResolution

public static Size getSystemResolution()

Returns current system resolution

Returns:

Resolution width and height

getResList

public static java.lang.String[] getResList()

Returns array string with all available resolutions

Returns:

String array with resolutions in format: [width]x[height];

getLangList

public static java.lang.String[] getLangList()

Returns array string with language options

Returns:

String array

getFowTypes

public static java.lang.String[] getFowTypes()

Returns array string with fog of war options

Returns:

String array

getMapRenderTypes

public static java.lang.String[] getMapRenderTypes()

Returns array with map rendering types

Returns:

String array

getScale

public static float getScale()

Returns scale for current resolution

Returns:

Float scale value

getEffectsVol

public static float getEffectsVol()

Returns audio effects volume level

Returns:

Volume level

getMusicVol

public static float getMusicVol()

Returns music volume level

Returns:

Volume level

getFowType

public static java.lang.String getFowType()

Returns current fog of war type

Returns:

String with current FOW type name

getMapRenderType

public static java.lang.String getMapRenderType()

Returns current map rendering type

Returns:

String with map rendering type name

getModuleName

public static java.lang.String getModuleName()

Returns game module name

Returns:

String with game module

isHwCursor

public static boolean isHwCursor()

Checks if hardware cursor is set

Returns:

True if hardware cursor is set, false otherwise

setResolution

public static void setResolution(Size resolution)

Sets specified size as game resolution(needs game restart)

Parameters:

resolution - Size with width and height

setLang

public static void setLang(java.lang.String langId)

Sets specified language with specified ID as game language

Parameters:

langId - String with lang ID

setFowType

public static void setFowType(java.lang.String fowTypeId)

Sets type of fog of war

Parameters:

fowTypeId - String with FOW type ID ('full', 'light' or 'off')

setMapRenderType

public static void setMapRenderType(java.lang.String mRenderType)

Sets map rendering type

Parameters:

mRenderType - String with desired map rendering type ID ('full' or 'light')

setEffectsVol

public static void setEffectsVol(float volLevel)

Sets effects volume level

Parameters:

volLevel - Desired volume level

setMusicVol

public static void setMusicVol(float volLevel)

Sets music volume level

Parameters:

volLevel - Desired volume level

setHwCursor

public static void setHwCursor(boolean hwCursor)

Enables or disables hardware cursor

Parameters:

hwCursor - True to enable hardware cursor, false to disable

saveSettings

public static boolean saveSettings()

Saves current settings to settings file

Returns:

True if settings was successfully saved, false otherwise