Package io.github.startsmercury.simply_no_shading.api.client

Interface SimplyNoShading

public interface SimplyNoShading
The Simply No Shading minecraft mod public interface.
Since:
7.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Config
    config()
    Gets the config.
    default @Nullable Path
    configPath()
    Gets the config path.
    static @NotNull SimplyNoShading
    instance()
    The Simply No Shading implementation instance.
    void
    setConfig(@NotNull Config config)
    Set the config by copying.

  • Method Details

    • instance

      @NotNull static @NotNull SimplyNoShading instance()
      The Simply No Shading implementation instance.

      It is discouraged for this method to return different instances for an implementation as callers may validly assume that the first valid instance is a singleton.

      Implementation Requirements:
      It is possible to call this method before an instance is present which may result in a runtime exception.

    • configPath

      @Nullable default @Nullable Path configPath() throws UnsupportedOperationException
      Gets the config path.

      This path is where the config will be stored and read from or null when not set.

      This is an optional operation.

      Returns:
      the client configuration file path
      Throws:
      UnsupportedOperationException - if getting the config path is not supported

    • config

      @NotNull @NotNull Config config()
      Gets the config.

      This mod's config is used for customization, determining which features should be expressed, how, or by how much.

      Returns:
      the config
      See Also:

    • setConfig

      void setConfig(@NotNull @NotNull Config config) throws NullPointerException
      Set the config by copying.

      Changes the config by copying from another value.

      Parameters:
      config - the config to copy values from
      Throws:
      NullPointerException - if the config is null
      See Also: