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

Interface SimplyNoShading

All Known Implementing Classes:
SimplyNoShadingImpl
public interface SimplyNoShading
Simply No Shading.

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

Since:
6.2.0

  • Method Summary

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

  • Method Details

    • instance

      @NotNull static @NotNull SimplyNoShading instance()
      The Simply No Shading implementation instance.
      Implementation Note
      It is possible to call this method before the instance is initialized, which may result in a runtime exception.
      Implementation Requirements
      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.

    • configPath

      Path configPath()
      Simply No Shading's client configuration file path.
      Implementation Requirements
      This method should preferably return the same path and should never be null.

    • config

      @NotNull @NotNull Config config()
      The Simply No Shading config.
      See Also:
      Implementation Requirements
      This method may return any non-null concrete implementation of Config and preferrably carry no side-effects to future calls to this method.

    • setConfig

      void setConfig(Config config)
      Changes the config.
      See Also:
      Implementation Requirements
      This method may throw an exception on null values and preferable copy the values to avoid untrivial side-effects.