Interface Wyck

All Known Implementing Classes:

Wyck.ShadedWyck

@NullMarked
@AsOf("2.1.0")
@NonExtendable
public interface Wyck

Common interface for miscellaneous Wyck (BiomesAPI) methods and utilities. Implemented by the main plugin class when running as a standalone plugin, and by a default implementation when shaded into a consumer plugin.

Since:

2.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Wyck.ShadedWyck	The default implementation of Wyck when shaded into a consumer plugin.

Field Summary

Fields

Modifier and Type	Field	Description
static final OptionalWireProvider<Wyck>	WIRE

Method Summary

Modifier and Type	Method	Description
default boolean	isExternal()
default boolean	isShaded()
default JavaPlugin	plugin()	Determines the plugin instance associated with Wyck.
default String	version()
static Wyck	wyck()

Field Details

WIRE

@Internal
static final OptionalWireProvider<Wyck> WIRE

Method Details

wyck

@AsOf("2.1.0")
static Wyck wyck()

Returns:

the active Wyck instance. When running as a standalone plugin, this is the Bukkit-managed plugin. When shaded into a consumer plugin, returns a default instance with no plugin context.

Since:

2.1.0

plugin

@AsOf("2.1.0")
default JavaPlugin plugin()

Determines the plugin instance associated with Wyck.

Returns:

the plugin instance if the library is running as a standalone plugin or JavaPlugin.getProvidingPlugin(Class) otherwise.

Throws:

IllegalStateException - if called from the static initializer for the given JavaPlugin

Since:

2.1.0

version

@AsOf("2.1.0")
default String version()

Returns:

the version of Wyck

Since:

2.1.0

isShaded

@AsOf("2.1.0")
default boolean isShaded()

Returns:

true if the library is shaded into a consumer plugin (no standalone instance available).

Since:

2.1.0

isExternal

@AsOf("2.1.0")
default boolean isExternal()

Returns:

true if the library is running as a standalone plugin.

Since:

2.1.0