Package org.spongepowered.api
Interface Game
- All Superinterfaces:
RegistryHolder
The core accessor of the API. The implementation uses this to pass
constructed objects.
-
Method Summary
Modifier and TypeMethodDescriptionGets the asyncScheduler
.Retrieves theBuilderProvider
.Gets theChannelManager
for creating network channels.default Client
client()
Gets theClient
.Gets theConfigManager
used to load and manage configuration files for plugins.Gets theEventManager
.Retrieves theFactoryProvider
.Gets the directory where the game's files are located.default boolean
Returns if theClient
is available for use.boolean
Returns if theServer
is available for use.Gets a locale for the specified locale code, e.g.Gets theMetricsConfigManager
instance, allowing data/metric gathering systems to determine whether they have permission to gather server metrics.platform()
Returns the current platform, or implementation, thisGame
is running on.Gets thePluginManager
.server()
Gets theServer
.Gets theServiceProvider.GameScoped
, used to provide Sponge services that plugins may provide.Gets theSystemSubject
.Methods inherited from interface org.spongepowered.api.registry.RegistryHolder
findRegistry, registry, streamRegistries
-
Method Details
-
asyncScheduler
Scheduler asyncScheduler()Gets the asyncScheduler
.- Returns:
- The async scheduler
-
gameDirectory
Path gameDirectory()Gets the directory where the game's files are located.- Returns:
- The game directory
-
isServerAvailable
boolean isServerAvailable()Returns if theServer
is available for use. The result of this method is entirely dependent on the implementation.- Returns:
- True if the Server is available, false if not
-
server
Server server()Gets theServer
.- Returns:
- The server
- Throws:
IllegalStateException
- If the Server isn't currently available
-
systemSubject
SystemSubject systemSubject()Gets theSystemSubject
. Depending on the implementation, this may also represent the game console.- Returns:
- The
SystemSubject
-
locale
Gets a locale for the specified locale code, e.g.en_US
.- Parameters:
locale
- The locale to lookup (e.g.en_US
.- Returns:
- The locale
-
isClientAvailable
default boolean isClientAvailable()Returns if theClient
is available for use. The result of this method is entirely dependent on the implementation.- Returns:
- True if the Client is available, false if not
-
client
Gets theClient
.- Returns:
- The client
- Throws:
UnsupportedEngineException
- If the client engine is not supportedIllegalStateException
- If the Client isn't currently available
-
platform
Platform platform()Returns the current platform, or implementation, thisGame
is running on.- Returns:
- The current implementation
-
builderProvider
BuilderProvider builderProvider()Retrieves theBuilderProvider
.- Returns:
- The builder provider
-
factoryProvider
FactoryProvider factoryProvider()Retrieves theFactoryProvider
.- Returns:
- The factory provider
-
dataManager
DataManager dataManager()- Returns:
- The serialization service
-
pluginManager
PluginManager pluginManager()Gets thePluginManager
.- Returns:
- The plugin manager
-
eventManager
EventManager eventManager()Gets theEventManager
.- Returns:
- The event manager
-
configManager
ConfigManager configManager()Gets theConfigManager
used to load and manage configuration files for plugins.- Returns:
- The configuration manager
-
channelManager
ChannelManager channelManager()Gets theChannelManager
for creating network channels.- Returns:
- The channel manager
-
metricsConfigManager
MetricsConfigManager metricsConfigManager()Gets theMetricsConfigManager
instance, allowing data/metric gathering systems to determine whether they have permission to gather server metrics.- Returns:
- The
MetricsConfigManager
instance
-
serviceProvider
ServiceProvider.GameScoped serviceProvider()Gets theServiceProvider.GameScoped
, used to provide Sponge services that plugins may provide. Services provided here are scoped to the lifetime of the Game.- Returns:
- The service manager
-