Package org.lazywizard.lazylib

Class LazyLib

Object

BaseModPlugin

LazyLib

All Implemented Interfaces:

ModPlugin

public class LazyLib
extends BaseModPlugin

Contains information on the current version of LazyLib.

Since:

1.1

Author:

LazyWizard

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MOD_ID

Constructor Summary

Constructors

Constructor	Description
LazyLib()

Method Summary

Modifier and Type	Method	Description
static String	getInfo()	Gets the library information (for startup messages, etc).
static Level	getLogLevel()	Returns the log level used for all other LazyLib classes.
static String	getSupportedGameVersion()	Returns the Starsector release this version was coded for.
static float	getVersion()	Returns the running version of LazyLib.
static boolean	isCachingEnabled()	Checks if caching of the results of expensive methods is enabled.
void	onApplicationLoad()
static void	onDeprecatedMethodUsage()	Called internally by LazyLib when a deprecated method is used.
static void	setLogLevel(Level level)	Sets the log level used for all other LazyLib classes.

Methods inherited from class BaseModPlugin

afterGameSave, beforeGameSave, configureXStream, onAboutToLinkCodexEntries, onAboutToStartGeneratingCodex, onCodexDataGenerated, onDevModeF8Reload, onEnabled, onGameLoad, onGameSaveFailed, onNewGame, onNewGameAfterEconomyLoad, onNewGameAfterProcGen, onNewGameAfterTimePass, pickDroneAI, pickMissileAI, pickShipAI, pickWeaponAutofireAI

Methods inherited from class Object

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

Field Details

MOD_ID

public static final String MOD_ID

See Also:

• Constant Field Values

Constructor Details

LazyLib

public LazyLib()

Method Details

getVersion

public static float getVersion()

Returns the running version of LazyLib. If your mod requires features from a certain version of LazyLib, this can be used to warn players that their version is out of date.

Returns:

The current version of LazyLib, as a Float.

Since:

1.1

getSupportedGameVersion

public static String getSupportedGameVersion()

Returns the Starsector release this version was coded for.

Returns:

The version of Starsector this library supports, as a String.

Since:

1.2

isCachingEnabled

public static boolean isCachingEnabled()

Checks if caching of the results of expensive methods is enabled.

Returns:

true if results caching is enabled, false otherwise.

Since:

1.8b

getInfo

public static String getInfo()

Gets the library information (for startup messages, etc).

Returns:

A String containing information on the library.

Since:

1.2

getLogLevel

public static Level getLogLevel()

Returns the log level used for all other LazyLib classes. LazyLib itself will always use log level Level.ALL.

Returns:

The current log level for all LazyLib classes.

Since:

1.6b

setLogLevel

public static void setLogLevel(Level level)

Sets the log level used for all other LazyLib classes.

Parameters:

level - The minimum level of entries that will be logged.

Since:

1.6

onDeprecatedMethodUsage

public static void onDeprecatedMethodUsage()

Called internally by LazyLib when a deprecated method is used. If "logDeprecated" is set in lazylib_settings.json it will log usage of those methods. If "crashOnDeprecated" is true, this method will throw a RuntimeException so modders can track down the problematic code using the stacktrace. You can ignore this method; there's no reason to ever call it manually, and calls from outside of LazyLib's namespace will be ignored.

Since:

1.7

onApplicationLoad

public void onApplicationLoad()
                       throws Exception

Specified by:

onApplicationLoad in interface ModPlugin

Overrides:

onApplicationLoad in class BaseModPlugin

Throws:

Exception