org.spongepowered.api

Interface Platform

public interface Platform

Represents a possible platform or implementation a Game could be running on.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Platform.Component Represents a part of the Platform.
static class	Platform.Type The type of the platform, or where the game is currently running.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_ID

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns this platform instance, as a key-value map.
default PluginContainer	getApi() Deprecated. Use getContainer(Component) with Platform.Component.API
PluginContainer	getContainer(Platform.Component component) Returns the PluginContainer for the specified platform Platform.Component.
Platform.Type	getExecutionType() Retrieves the current Platform.Type the platform is executing on.
default PluginContainer	getImplementation() Deprecated. Use getContainer(Component) with Platform.Component.IMPLEMENTATION
MinecraftVersion	getMinecraftVersion() Gets the current Minecraft version of this platform.
Platform.Type	getType() Retrieves the current Platform.Type this platform is running on.

Field Detail

API_ID

static final String API_ID

See Also:

Constant Field Values

Method Detail

getType

Platform.Type getType()

Retrieves the current Platform.Type this platform is running on.

Returns:

The current type

getExecutionType

Platform.Type getExecutionType()

Retrieves the current Platform.Type the platform is executing on.

A Minecraft instance will have a client and server thread. If the server is executing, this will return Platform.Type.SERVER but getType() would return Platform.Type.CLIENT.

Returns:

The execution type

getContainer

PluginContainer getContainer(Platform.Component component)

Returns the PluginContainer for the specified platform Platform.Component.

Parameters:

component - The platform component

Returns:

The plugin container for the component

getApi

@Deprecated
default PluginContainer getApi()

Deprecated. Use getContainer(Component) with Platform.Component.API

Returns the current API plugin container.

Returns:

The API plugin container

getImplementation

@Deprecated
default PluginContainer getImplementation()

Deprecated. Use getContainer(Component) with Platform.Component.IMPLEMENTATION

Returns the current implementation plugin container.

Returns:

The implementation plugin container

getMinecraftVersion

MinecraftVersion getMinecraftVersion()

Gets the current Minecraft version of this platform.

Returns:

The Minecraft version

asMap

Map<String,Object> asMap()

Returns this platform instance, as a key-value map.

The returned map instance is connected directly to this platform instance. Existing keys like name and version are not modifiable, but new keys are stored in this instance and are shared between any references to a map obtained through the retrieved map.

This mechanism allows for platform-specific information like Forge version.

Returns:

This platform as a map