Module SettingsManager

Manager of Game Settings

Functions

Settings.isFullscreenActive () Identifies is full screen mode is active or not
Settings.getScreenWidth () Get screen width settings (don't returns real screen width)
Settings.getScreenHeight () Get screen height settings (don't returns real screen height)
Settings.getFrameRate () Get pre-confirued framerate value
Settings.getTicksPerSecond () Get pre-confirued framerate value, alias to Settings.getFrameRate
Settings.useFrameSkip () Get a frame skip value
Settings.getSoundVolume () Get a master sound volume value
Settings.getMusicVolume () Get a master music volume value
Settings.isDebugInfoShown () Is debug information showing is turned on?
Settings.setDebugInfoShown (State) Turn on debug information visibility


Functions

Settings.isFullscreenActive ()
Identifies is full screen mode is active or not

Returns:

    bool true if is a fullscree mode, or false if windowed.
Settings.getScreenWidth ()
Get screen width settings (don't returns real screen width)

Returns:

    int Width of screen from settings
Settings.getScreenHeight ()
Get screen height settings (don't returns real screen height)

Returns:

    int Height of screen from settings
Settings.getFrameRate ()
Get pre-confirued framerate value

Returns:

    double Frames per second value
Settings.getTicksPerSecond ()
Get pre-confirued framerate value, alias to Settings.getFrameRate

Returns:

    double Frames per second value
Settings.useFrameSkip ()
Get a frame skip value

Returns:

    bool true if frameskip is turned on
Settings.getSoundVolume ()
Get a master sound volume value

Returns:

    int Sound volume value between 0 and 128
Settings.getMusicVolume ()
Get a master music volume value

Returns:

    int Sound volume value between 0 and 128
Settings.isDebugInfoShown ()
Is debug information showing is turned on?

Returns:

    bool state of debug information visibility
Settings.setDebugInfoShown (State)
Turn on debug information visibility

Parameters:

  • State bool of debug information visibility
generated by LDoc 1.4.6 Last updated 2017-08-21 02:20:32