net.caseif.flint

Class FlintCore

java.lang.Object

net.caseif.flint.FlintCore

public abstract class FlintCore
extends Object

The core class for the Flint framework.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static FlintCore	INSTANCE

Constructor Summary

Constructors

Constructor and Description
FlintCore()

Method Summary

Modifier and Type	Method and Description
static int	getApiRevision() Gets the current API revision.
protected static String	getCodename() Gets the codename of the current API revision.
static String	getImplementationName() Gets the name of the software currently implementing Flint.
protected abstract String	getImplementationName0()
static int	getMajorVersion() Gets the current API major version.
static Minigame	registerPlugin(String pluginId) Registers a plugin as a Flint-backed Minigame.
protected abstract Minigame	registerPlugin0(String pluginId)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

protected static FlintCore INSTANCE

Constructor Detail

FlintCore

public FlintCore()

Method Detail

getApiRevision

public static int getApiRevision()

Gets the current API revision. Note that this is not necessarily parallel to its version string.

The API revision is incremented for each version (discounting snapshot builds) which modifies Flint's API.

Returns:

The current API revision

Since:

1.0

getMajorVersion

public static int getMajorVersion()

Gets the current API major version. Note that breaking changes may occur across major versions, so plugins should be careful to check for a specific value from this method (i.e. not a range).

Returns:

The current API major version

Since:

1.3

getCodename

protected static String getCodename()

Gets the codename of the current API revision. This method is intended for internal use by implementations of the engine.

Returns:

The codename of the current API revision

Since:

1.3

getImplementationName

public static String getImplementationName()

Gets the name of the software currently implementing Flint.

Returns:

The name of the software currently implementing Flint

Since:

1.0

getImplementationName0

protected abstract String getImplementationName0()

registerPlugin

public static Minigame registerPlugin(String pluginId)
                               throws IllegalStateException

Registers a plugin as a Flint-backed Minigame.

Parameters:

pluginId - The name or ID of the plugin to register

Returns:

The newly created Minigame associated with the plugin

Throws:

IllegalStateException - If a plugin with the given ID has already been registered as a Minigame

Since:

1.0

registerPlugin0

protected abstract Minigame registerPlugin0(String pluginId)
                                     throws IllegalStateException

Throws:

IllegalStateException