public interface Platform
Game
could be
running on.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.
|
Modifier and Type | Method and Description |
---|---|
Map<String,Object> |
asMap()
Returns this platform instance, as a key-value map.
|
default PluginContainer |
getApi()
Deprecated.
|
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.
|
MinecraftVersion |
getMinecraftVersion()
Gets the current Minecraft version of this platform.
|
Platform.Type |
getType()
Retrieves the current
Platform.Type this platform is running on. |
static final String API_ID
Platform.Type getType()
Platform.Type
this platform is running on.Platform.Type getExecutionType()
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.
PluginContainer getContainer(Platform.Component component)
PluginContainer
for the specified platform
Platform.Component
.component
- The platform component@Deprecated default PluginContainer getApi()
getContainer(Component)
with
Platform.Component.API
@Deprecated default PluginContainer getImplementation()
getContainer(Component)
with
Platform.Component.IMPLEMENTATION
MinecraftVersion getMinecraftVersion()
Map<String,Object> asMap()
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.