Package net.darkhax.pricklemc.common.api.util

Interface IPlatformHelper

public interface IPlatformHelper
The PlatformHelper provides useful context and information about the platform the game is running on.

  • Method Summary

    Modifier and Type
    Method
    Description
    default File
    getConfigDirectory()
    Gets the specified configuration directory as a file reference.
    Path
    getConfigPath()
    Gets the specified configuration path for the game.
    String
    getName()
    Gets the name of the platform.

  • Method Details

    • getConfigPath

      Path getConfigPath()
      Gets the specified configuration path for the game.
      Returns:
      The specified configuration path for the game.

    • getConfigDirectory

      default File getConfigDirectory()
      Gets the specified configuration directory as a file reference.
      Returns:
      The specified configuration path for the game.

    • getName

      String getName()
      Gets the name of the platform.
      Returns:
      The name of the platform.