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 and Description
@NotNull Config	config() Gets the config.
default @Nullable java.nio.file.Path	configPath() Gets the config path.
static @NotNull SimplyNoShading	instance() Gets the singleton implementation of this class.
void	setConfig(@NotNull Config config) Set the config by copying.

Method Detail

instance

@NotNull
static @NotNull SimplyNoShading instance()

Gets the singleton implementation of this class.

Returns:

an instance of this class

Throws:

java.lang.RuntimeException - if the single instance is not yet available

configPath

@Nullable
default @Nullable java.nio.file.Path configPath()
                                                   throws java.lang.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:

java.lang.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(Config)

setConfig

void setConfig(@NotNull
               @NotNull Config config)
        throws java.lang.NullPointerException

Set the config by copying.

Changes the config by copying from another value.

Parameters:

config - the config to copy values from

Throws:

java.lang.NullPointerException - if the config is null

See Also:

config()