Interface IPlatformHelper

All Known Implementing Classes:
NeoForgePlatformHelper

public interface IPlatformHelper
Platform helper which provides information which platform the mod is running on.
  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    Returns the name of the current environment as a string.
    Returns the name of the platform.
    boolean
    Checks if the current environment is a development environment.
    boolean
    Checks if a mod is loaded given its mod ID.
  • Method Details

    • getPlatformName

      String getPlatformName()
      Returns the name of the platform.
      Returns:
      The platform name.
    • isModLoaded

      boolean isModLoaded(String modId)
      Checks if a mod is loaded given its mod ID.
      Parameters:
      modId - ID of the mod being checked.
      Returns:
      True if the mod is loaded, otherwise returns false.
    • isDevelopmentEnvironment

      boolean isDevelopmentEnvironment()
      Checks if the current environment is a development environment.
      Returns:
      True if current environment is a development environment, otherwise returns false.
    • getEnvironmentName

      default String getEnvironmentName()
      Returns the name of the current environment as a string.
      Returns:
      The environment name.