Package xaero.pac.client.player.config.api

Interface IPlayerConfigClientStorageManagerAPI

public interface IPlayerConfigClientStorageManagerAPI
API for the player config storage manager on the client side

  • Method Details

    • getServerClaimsConfig

      @Nonnull IPlayerConfigClientStorageAPI getServerClaimsConfig()
      Gets the read-only "player config" storage for the server claims.
      Returns:
      the server claims config, not null

    • getExpiredClaimsConfig

      @Nonnull IPlayerConfigClientStorageAPI getExpiredClaimsConfig()
      Gets the read-only "player config" storage for the expired claims.
      Returns:
      the expired claims config, not null

    • getWildernessConfig

      @Nonnull IPlayerConfigClientStorageAPI getWildernessConfig()
      Gets the read-only "player config" storage for the wilderness.
      Returns:
      the wilderness config, not null

    • getDefaultPlayerConfig

      @Nonnull IPlayerConfigClientStorageAPI getDefaultPlayerConfig()
      Gets the read-only storage for the default player config.
      Returns:
      the default player config, not null

    • getMyPlayerConfig

      @Nonnull IPlayerConfigClientStorageAPI getMyPlayerConfig()
      Gets the read-only storage for the local client player's config.
      Returns:
      the local player's config, not null

    • openServerClaimsConfigScreen

      void openServerClaimsConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent)
      Opens the config GUI screen for the server claims "player config".
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null

    • openExpiredClaimsConfigScreen

      void openExpiredClaimsConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent)
      Opens the config GUI screen for the expired claims "player config".
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null

    • openWildernessConfigScreen

      void openWildernessConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent)
      Opens the config GUI screen for the wilderness "player config".
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null

    • openDefaultPlayerConfigScreen

      void openDefaultPlayerConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent)
      Opens the config GUI screen for the default player config.
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null

    • openMyPlayerConfigScreen

      void openMyPlayerConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent)
      Opens the config GUI screen for the local client player's config.
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null

    • openOtherPlayerConfigScreen

      void openOtherPlayerConfigScreen(@Nullable net.minecraft.client.gui.screens.Screen escape, @Nullable net.minecraft.client.gui.screens.Screen parent, @Nonnull String playerName)
      Opens the config GUI screen for the player with a specified username.
      Parameters:
      escape - the screen to switch to when the escape key is hit, can be null
      parent - the screen to switch to when the screen is exited normally, can be null
      playerName - the username of the player, not null

    • getAllOptionsStream

      @Nonnull Stream<IPlayerConfigOptionSpecAPI<?>> getAllOptionsStream()
      Gets a stream of all player config option types, including the dynamic ones.
      Returns:
      a stream of all player config options, not null

    • getOptionForId

      @Nullable IPlayerConfigOptionSpecAPI<?> getOptionForId(@Nonnull String id)
      Gets the option type specification with a specified string option id, including dynamic options.

      Returns null if no such option exists.

      Parameters:
      id - the option id, not null
      Returns:
      the option type specification instance, null when doesn't exist