Package org.spongepowered.api

Interface Platform

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

  • Field Details

  • Method Details

    • type

      Platform.Type type()
      Retrieves the current Platform.Type this platform is running on.
      Returns:
      The current type

    • executionType

      Platform.Type executionType()
      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 type() would return Platform.Type.CLIENT.

      Returns:
      The execution type

    • container

      org.spongepowered.plugin.PluginContainer container(Platform.Component component)
      Returns the PluginContainer for the specified platform Platform.Component.
      Parameters:
      component - The platform component
      Returns:
      The plugin container for the component

    • minecraftVersion

      MinecraftVersion minecraftVersion()
      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