Package org.geysermc.geyser.platform.mod.platform

Interface GeyserModPlatform

public interface GeyserModPlatform
An interface which holds common methods that have different APIs on their respective mod platforms.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    configPath()
    Gets the config path of the mod platform.
    @NonNull Path
    dataFolder(@NonNull String modId)
    Gets the data folder of the mod platform.
    @NonNull org.geysermc.geyser.dump.BootstrapDumpInfo
    dumpInfo(@NonNull net.minecraft.server.MinecraftServer server)
    Gets the dump info of the mod platform.
    @NonNull org.geysermc.geyser.api.util.PlatformType
    platformType()
    Gets the PlatformType of the mod platform.
    @Nullable InputStream
    resolveResource(@NonNull String resource)
    Resolves a resource from the mod jar.
    boolean
    testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap)
    Tests if the Floodgate plugin is present on the mod platform.

  • Method Details

    • platformType

      @NonNull org.geysermc.geyser.api.util.PlatformType platformType()
      Gets the PlatformType of the mod platform.
      Returns:
      the platform type of the mod platform

    • configPath

      @NonNull String configPath()
      Gets the config path of the mod platform.
      Returns:
      the config path of the mod platform

    • dataFolder

      @NonNull Path dataFolder(@NonNull String modId)
      Gets the data folder of the mod platform.
      Returns:
      the data folder of the mod platform

    • dumpInfo

      @NonNull org.geysermc.geyser.dump.BootstrapDumpInfo dumpInfo(@NonNull net.minecraft.server.MinecraftServer server)
      Gets the dump info of the mod platform.
      Parameters:
      server - the server to get the dump info from
      Returns:
      the dump info of the mod platform

    • testFloodgatePluginPresent

      boolean testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap)
      Tests if the Floodgate plugin is present on the mod platform.
      Returns:
      true if the Floodgate plugin is present on the mod platform, false otherwise

    • resolveResource

      @Nullable InputStream resolveResource(@NonNull String resource)
      Resolves a resource from the mod jar.
      Parameters:
      resource - the name of the resource
      Returns:
      the input stream of the resource