org.spongepowered.api

Class Sponge

java.lang.Object

org.spongepowered.api.Sponge

public final class Sponge
extends Object

A static all access class granting static access to various systems for the API.

Constructor Summary

Constructors

Constructor and Description
Sponge()

Method Summary

Modifier and Type	Method and Description
static AssetManager	getAssetManager() Gets the AssetManager instance.
static CauseStackManager	getCauseStackManager() Gets the CauseStackManager instance from the Game instance.
static ChannelRegistrar	getChannelRegistrar() Gets the ChannelRegistrar for creating network channels.
static CommandManager	getCommandManager() Gets the CommandManager instance.
static ConfigManager	getConfigManager() Gets the ConfigManager used to load and manage configuration files for plugins.
static DataManager	getDataManager() Gets the DataManager instance.
static Optional<GameDictionary>	getDictionary() Gets the GameDictionary instance from the Game instance.
static EventManager	getEventManager() Gets the EventManager instance.
static Game	getGame() Gets the Game instance.
static MetricsConfigManager	getMetricsConfigManager() Gets the MetricsConfigManager instance, allowing data/metric gathering systems to determine whether they have permission to gather server metrics.
static Platform	getPlatform() Returns the current platform, or implementation, this Game is running on.
static PluginManager	getPluginManager() Gets the PluginManager instance.
static PropertyRegistry	getPropertyRegistry() Gets the PropertyRegistry instance to register PropertyStores.
static GameRegistry	getRegistry() Gets the GameRegistry instance.
static Scheduler	getScheduler() Gets the scheduler used to schedule tasks.
static Server	getServer() Gets the Server instance from the Game instance.
static ServiceManager	getServiceManager() Gets the game's instance of the service manager, which is the gateway to various services provided by Sponge (command registration and so on).
static TeleportHelper	getTeleportHelper() Gets the TeleportHelper, used to find safe Locations.
static boolean	isServerAvailable() Gets whether a Server instance is available without throwing an exception from calling getServer().

Methods inherited from class java.lang.Object

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

Constructor Detail

Sponge

public Sponge()

Method Detail

getGame

public static Game getGame()

Gets the Game instance. There is ever only going to be a single game instance at any given time, except during the various extraneous GameStates that the game instance is otherwise unavailable.

Returns:

The game instance

getPlatform

public static Platform getPlatform()

Returns the current platform, or implementation, this Game is running on.

Returns:

The current implementation

getRegistry

public static GameRegistry getRegistry()

Gets the GameRegistry instance.

Returns:

The game registry instance

getDataManager

public static DataManager getDataManager()

Gets the DataManager instance.

Returns:

The data manager instance

getPropertyRegistry

public static PropertyRegistry getPropertyRegistry()

Gets the PropertyRegistry instance to register PropertyStores.

Returns:

The property registry

getPluginManager

public static PluginManager getPluginManager()

Gets the PluginManager instance.

Returns:

The plugin manager instance

getEventManager

public static EventManager getEventManager()

Gets the EventManager instance.

Returns:

The event manager instance

getAssetManager

public static AssetManager getAssetManager()

Gets the AssetManager instance.

Returns:

The asset manager instance

getConfigManager

public static ConfigManager getConfigManager()

Gets the ConfigManager used to load and manage configuration files for plugins.

Returns:

The configuration manager

getCommandManager

public static CommandManager getCommandManager()

Gets the CommandManager instance.

Returns:

The command manager instance

getServiceManager

public static ServiceManager getServiceManager()

Gets the game's instance of the service manager, which is the gateway to various services provided by Sponge (command registration and so on).

Services registered by other plugins may be available too.

Returns:

The service manager

getScheduler

public static Scheduler getScheduler()

Gets the scheduler used to schedule tasks.

Returns:

The scheduler

getChannelRegistrar

public static ChannelRegistrar getChannelRegistrar()

Gets the ChannelRegistrar for creating network channels.

Returns:

The channel registrar

getTeleportHelper

public static TeleportHelper getTeleportHelper()

Gets the TeleportHelper, used to find safe Locations.

Returns:

The teleport helper

isServerAvailable

public static boolean isServerAvailable()

Gets whether a Server instance is available without throwing an exception from calling getServer().

Returns:

True if the server instance is available

See Also:

Game.isServerAvailable()

getServer

public static Server getServer()

Gets the Server instance from the Game instance.

Note: During various GameStates, a Server instance may NOT be available. During these specific states, calling Game.getServer() will throw an exception. To double check, call isServerAvailable()

Returns:

The server instance

See Also:

Game.getServer(), Game.isServerAvailable()

getDictionary

public static Optional<GameDictionary> getDictionary()

Gets the GameDictionary instance from the Game instance.

Returns:

The game dictionary instance, or empty if unsupported

See Also:

Game.getGameDictionary()

getCauseStackManager

public static CauseStackManager getCauseStackManager()

Gets the CauseStackManager instance from the Game instance.

Returns:

The cause stack manager instance

See Also:

Game.getCauseStackManager()

getMetricsConfigManager

public static MetricsConfigManager getMetricsConfigManager()

Gets the MetricsConfigManager instance, allowing data/metric gathering systems to determine whether they have permission to gather server metrics.

Returns:

The MetricsConfigManager instance