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

Interface SimplyNoShading

public interface SimplyNoShading
Simply No Shading.

A concrete instance of this class represents the state of Simply No Shading as a Minecraft modification.

Since:
7.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Config
    config()
    The Simply No Shading config.
    @NotNull Path
    configPath()
    Simply No Shading's client configuration file path.
    static @NotNull SimplyNoShading
    instance()
    The Simply No Shading implementation instance.
    void
    setConfig(@NotNull Config config)
    Changes the config by copying values.

  • 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

      @NotNull @NotNull Path configPath()
      Simply No Shading's client configuration file path.

      This method returns the same non-null path to the client configuration file.

      Returns:
      the client configuration file path

    • config

      @NotNull @NotNull Config config()
      The Simply No Shading config.

      This returns a non-null read-only view or copy of config. The returned config must not affect later calls to this method.

      See Also:

    • setConfig

      void setConfig(@NotNull @NotNull Config config)
      Changes the config by copying values.

      Copies another config such that changes from it will not be reflected (see config()).

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