org.anvilpowered.anvil.api.plugin

Interface Plugin<TPluginContainer>

All Superinterfaces:

java.lang.Comparable<Plugin<TPluginContainer>>, Named

All Known Implementing Classes:

BasePlugin

public interface Plugin<TPluginContainer>
extends Named, java.lang.Comparable<Plugin<TPluginContainer>>

Method Summary

Modifier and Type	Method and Description
default java.util.Set<Environment>	getAllEnvironments()
TPluginContainer	getPluginContainer()
default Environment	getPrimaryEnvironment() Note: while not explicitly necessary, it is generally advisable to override this method by getting the Environment from Environment.Builder#whenReady(Consumer) and setting it in a field in your implementing class

Methods inherited from interface org.anvilpowered.anvil.api.misc.Named

getName

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPluginContainer

TPluginContainer getPluginContainer()

getPrimaryEnvironment

default Environment getPrimaryEnvironment()

Note: while not explicitly necessary, it is generally advisable to override this method by getting the Environment from Environment.Builder#whenReady(Consumer) and setting it in a field in your implementing class

Returns:

The primary Environment for this Plugin

getAllEnvironments

default java.util.Set<Environment> getAllEnvironments()

Returns:

A Set of all environments registered to this Plugin