Package com.hypixel.hytale.server.core.plugin

Class PluginBase

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

All Implemented Interfaces:

CommandOwner

Direct Known Subclasses:

JavaPlugin

public abstract class PluginBase
extends Object
implements CommandOwner

Field Summary

Fields

Modifier and Type	Field	Description
private final AssetRegistry	assetRegistry
private final String	basePermission
private final BlockStateRegistry	blockStateRegistry
private final ComponentRegistryProxy<ChunkStore>	chunkStoreRegistry
private final ClientFeatureRegistry	clientFeatureRegistry
private final Map<Codec<?>,IRegistry>	codecMapRegistries
private final CommandRegistry	commandRegistry
private final List<Config<?>>	configs
private final Path	dataDirectory
private final EntityRegistry	entityRegistry
private final ComponentRegistryProxy<EntityStore>	entityStoreRegistry
private final EventRegistry	eventRegistry
private final PluginIdentifier	identifier
private final com.hypixel.hytale.logger.HytaleLogger	logger
private final PluginManifest	manifest
static final MetricsRegistry<PluginBase>	METRICS_REGISTRY
private final String	notEnabledString
private final CopyOnWriteArrayList<BooleanConsumer>	shutdownTasks
private PluginState	state
private final TaskRegistry	taskRegistry

Constructor Summary

Constructors

Constructor	Description
PluginBase(PluginInit init)

Method Summary

Modifier and Type	Method	Description
(package private) void	cleanup(boolean shutdown)
AssetRegistry	getAssetRegistry()
final String	getBasePermission()
BlockStateRegistry	getBlockStateRegistry()
ComponentRegistryProxy<ChunkStore>	getChunkStoreRegistry()
ClientFeatureRegistry	getClientFeatureRegistry()
<K, T extends JsonAsset<K>> CodecMapRegistry.Assets<T,?>	getCodecRegistry(AssetCodecMapCodec<K,T> mapCodec)
<V> MapKeyMapRegistry<V>	getCodecRegistry(com.hypixel.hytale.codec.lookup.MapKeyMapCodec<V> mapCodec)
<T, C extends Codec<? extends T>> CodecMapRegistry<T,C>	getCodecRegistry(StringCodecMapCodec<T,C> mapCodec)
CommandRegistry	getCommandRegistry()
Path	getDataDirectory()
EntityRegistry	getEntityRegistry()
ComponentRegistryProxy<EntityStore>	getEntityStoreRegistry()
EventRegistry	getEventRegistry()
PluginIdentifier	getIdentifier()
com.hypixel.hytale.logger.HytaleLogger	getLogger()
PluginManifest	getManifest()
String	getName()
PluginState	getState()
TaskRegistry	getTaskRegistry()
abstract PluginType	getType()
boolean	isDisabled()
boolean	isEnabled()
CompletableFuture<Void>	preLoad()
protected void	setup()
protected void	setup0()
protected void	shutdown()
protected void	shutdown0(boolean shutdown)
protected void	start()
protected void	start0()
protected final <T> Config<T>	withConfig(BuilderCodec<T> configCodec)
protected final <T> Config<T>	withConfig(String name, BuilderCodec<T> configCodec)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

METRICS_REGISTRY

@Nonnull
public static final MetricsRegistry<PluginBase> METRICS_REGISTRY

logger

@Nonnull
private final com.hypixel.hytale.logger.HytaleLogger logger

identifier

@Nonnull
private final PluginIdentifier identifier

manifest

@Nonnull
private final PluginManifest manifest

dataDirectory

@Nonnull
private final Path dataDirectory

configs

@Nonnull
private final List<Config<?>> configs

state

@Nonnull
private PluginState state

notEnabledString

private final String notEnabledString

shutdownTasks

@Nonnull
private final CopyOnWriteArrayList<BooleanConsumer> shutdownTasks

clientFeatureRegistry

private final ClientFeatureRegistry clientFeatureRegistry

commandRegistry

private final CommandRegistry commandRegistry

eventRegistry

private final EventRegistry eventRegistry

blockStateRegistry

private final BlockStateRegistry blockStateRegistry

entityRegistry

private final EntityRegistry entityRegistry

taskRegistry

private final TaskRegistry taskRegistry

entityStoreRegistry

private final ComponentRegistryProxy<EntityStore> entityStoreRegistry

chunkStoreRegistry

private final ComponentRegistryProxy<ChunkStore> chunkStoreRegistry

assetRegistry

private final AssetRegistry assetRegistry

codecMapRegistries

private final Map<Codec<?>,IRegistry> codecMapRegistries

basePermission

@Nonnull
private final String basePermission

Constructor Details

PluginBase

public PluginBase(@Nonnull
 PluginInit init)

Method Details

withConfig

@Nonnull
protected final <T> Config<T> withConfig(@Nonnull
 BuilderCodec<T> configCodec)

withConfig

@Nonnull
protected final <T> Config<T> withConfig(@Nonnull
 String name,
 @Nonnull
 BuilderCodec<T> configCodec)

preLoad

@Nullable
public CompletableFuture<Void> preLoad()

getName

@Nonnull
public String getName()

Specified by:

getName in interface CommandOwner

getLogger

@Nonnull
public com.hypixel.hytale.logger.HytaleLogger getLogger()

getIdentifier

@Nonnull
public PluginIdentifier getIdentifier()

getManifest

@Nonnull
public PluginManifest getManifest()

getDataDirectory

@Nonnull
public Path getDataDirectory()

getState

@Nonnull
public PluginState getState()

getClientFeatureRegistry

@Nonnull
public ClientFeatureRegistry getClientFeatureRegistry()

getCommandRegistry

@Nonnull
public CommandRegistry getCommandRegistry()

getEventRegistry

@Nonnull
public EventRegistry getEventRegistry()

getBlockStateRegistry

@Nonnull
public BlockStateRegistry getBlockStateRegistry()

getEntityRegistry

@Nonnull
public EntityRegistry getEntityRegistry()

getTaskRegistry

@Nonnull
public TaskRegistry getTaskRegistry()

getEntityStoreRegistry

@Nonnull
public ComponentRegistryProxy<EntityStore> getEntityStoreRegistry()

getChunkStoreRegistry

@Nonnull
public ComponentRegistryProxy<ChunkStore> getChunkStoreRegistry()

getAssetRegistry

@Nonnull
public AssetRegistry getAssetRegistry()

getCodecRegistry

@Nonnull
public <T,
C extends Codec<? extends T>>
CodecMapRegistry<T,C> getCodecRegistry(@Nonnull
 StringCodecMapCodec<T,C> mapCodec)

getCodecRegistry

@Nonnull
public <K,
T extends JsonAsset<K>>
CodecMapRegistry.Assets<T,?> getCodecRegistry(@Nonnull
 AssetCodecMapCodec<K,T> mapCodec)

getCodecRegistry

@Nonnull
public <V> MapKeyMapRegistry<V> getCodecRegistry(@Nonnull
 com.hypixel.hytale.codec.lookup.MapKeyMapCodec<V> mapCodec)

getBasePermission

@Nonnull
public final String getBasePermission()

isDisabled

public boolean isDisabled()

isEnabled

public boolean isEnabled()

setup0

protected void setup0()

setup

protected void setup()

start0

protected void start0()

start

protected void start()

shutdown0

protected void shutdown0(boolean shutdown)

shutdown

protected void shutdown()

cleanup

void cleanup(boolean shutdown)

getType

@Nonnull
public abstract PluginType getType()