Package net.darkhax.bookshelf.impl.util

Class PlatformHelperNeoForge

java.lang.Object
net.darkhax.bookshelf.impl.util.PlatformHelperNeoForge
All Implemented Interfaces:
IPlatformHelper
public class PlatformHelperNeoForge extends Object implements IPlatformHelper

  • Constructor Details

    • PlatformHelperNeoForge

      public PlatformHelperNeoForge()

  • Method Details

    • getGamePath

      public Path getGamePath()
      Description copied from interface: IPlatformHelper
      Gets the working directory path of the game directory.
      Specified by:
      getGamePath in interface IPlatformHelper
      Returns:
      The working directory path of the game directory.

    • getConfigPath

      public Path getConfigPath()
      Description copied from interface: IPlatformHelper
      Gets the specified configuration path for the game.
      Specified by:
      getConfigPath in interface IPlatformHelper
      Returns:
      The specified configuration path for the game.

    • getModsPath

      public Path getModsPath()
      Description copied from interface: IPlatformHelper
      Gets the primary path that the current loader will load mods from.
      Specified by:
      getModsPath in interface IPlatformHelper
      Returns:
      The currently specified mods path.

    • isModLoaded

      public boolean isModLoaded(String modId)
      Description copied from interface: IPlatformHelper
      Checks if a given mod is loaded.
      Specified by:
      isModLoaded in interface IPlatformHelper
      Parameters:
      modId - The mod id to search for.
      Returns:
      True when the specified mod id has been loaded.

    • isDevelopmentEnvironment

      public boolean isDevelopmentEnvironment()
      Description copied from interface: IPlatformHelper
      Checks if the mod is running in a development environment.
      Specified by:
      isDevelopmentEnvironment in interface IPlatformHelper
      Returns:
      True when the mod is running in a developer environment.

    • getPhysicalSide

      public PhysicalSide getPhysicalSide()
      Description copied from interface: IPlatformHelper
      Gets the physical environment that the code is running on.
      Specified by:
      getPhysicalSide in interface IPlatformHelper
      Returns:
      The physical environment that the code is running on.

    • getModName

      @Nullable public @Nullable String getModName(String modId)
      Description copied from interface: IPlatformHelper
      Attempts to resolve the name of a mod using the associated mod ID. If no mod is not available the provided ID will be treated as the name.
      Specified by:
      getModName in interface IPlatformHelper
      Parameters:
      modId - The ID of the mod to lookup.
      Returns:
      The name of the mod associated with the given mod ID. If no mod is not available the provided ID will be treated as the name.

    • isTestingEnvironment

      public boolean isTestingEnvironment()
      Description copied from interface: IPlatformHelper
      Checks if the mod is currently running in an environment with game tests enabled.
      Specified by:
      isTestingEnvironment in interface IPlatformHelper
      Returns:
      Are game tests currently enabled?

    • getName

      public String getName()
      Description copied from interface: IPlatformHelper
      Gets the name of the platform.
      Specified by:
      getName in interface IPlatformHelper
      Returns:
      The name of the platform.