Module net.minestom.server

Package net.minestom.server.instance

Class InstanceManager

java.lang.Object

net.minestom.server.instance.InstanceManager

public final class InstanceManager
extends Object

Used to register Instance.

Constructor Summary

Constructors

Constructor	Description
InstanceManager(Registries registries)

Method Summary

Modifier and Type	Method	Description
InstanceContainer	createInstanceContainer()	Creates and register an InstanceContainer.
InstanceContainer	createInstanceContainer(@Nullable IChunkLoader loader)
InstanceContainer	createInstanceContainer(RegistryKey<DimensionType> dimensionType)
InstanceContainer	createInstanceContainer(RegistryKey<DimensionType> dimensionType, @Nullable IChunkLoader loader)	Creates and register an InstanceContainer with the specified DimensionType.
SharedInstance	createSharedInstance(InstanceContainer instanceContainer)	Creates and register a SharedInstance.
@Nullable Instance	getInstance(UUID uuid)	Gets an instance by the given UUID.
Set<Instance>	getInstances()	Gets all the registered instances.
void	registerInstance(Instance instance)	Registers an Instance internally.
SharedInstance	registerSharedInstance(SharedInstance sharedInstance)	Registers a SharedInstance.
void	unregisterInstance(Instance instance)	Unregisters the Instance internally.

Methods inherited from class java.lang.Object

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

Constructor Details

InstanceManager

public InstanceManager(Registries registries)

Method Details

registerInstance

public void registerInstance(Instance instance)

Registers an Instance internally.

Note: not necessary if you created your instance using createInstanceContainer() or createSharedInstance(InstanceContainer) but only if you instantiated your instance object manually

Parameters:

instance - the Instance to register

createInstanceContainer

public InstanceContainer createInstanceContainer(RegistryKey<DimensionType> dimensionType,
 @Nullable
 @Nullable IChunkLoader loader)

Creates and register an InstanceContainer with the specified DimensionType.

Parameters:

dimensionType - the DimensionType of the instance

loader - the chunk loader

Returns:

the created InstanceContainer

createInstanceContainer

public InstanceContainer createInstanceContainer(RegistryKey<DimensionType> dimensionType)

createInstanceContainer

public InstanceContainer createInstanceContainer(@Nullable
 @Nullable IChunkLoader loader)

createInstanceContainer

public InstanceContainer createInstanceContainer()

Creates and register an InstanceContainer.

Returns:

the created InstanceContainer

registerSharedInstance

public SharedInstance registerSharedInstance(SharedInstance sharedInstance)

Registers a SharedInstance.

WARNING: the SharedInstance needs to have an InstanceContainer assigned to it.

Parameters:

sharedInstance - the SharedInstance to register

Returns:

the registered SharedInstance

Throws:

NullPointerException - if sharedInstance doesn't have an InstanceContainer assigned to it

createSharedInstance

public SharedInstance createSharedInstance(InstanceContainer instanceContainer)

Creates and register a SharedInstance.

Parameters:

instanceContainer - the container assigned to the shared instance

Returns:

the created SharedInstance

Throws:

IllegalStateException - if instanceContainer is not registered

unregisterInstance

public void unregisterInstance(Instance instance)

Unregisters the Instance internally.

If instance is an InstanceContainer all chunks are unloaded.

Parameters:

instance - the Instance to unregister

getInstances

public Set<Instance> getInstances()

Gets all the registered instances.

Returns:

an unmodifiable Set containing all the registered instances

getInstance

@Nullable
public @Nullable Instance getInstance(UUID uuid)

Gets an instance by the given UUID.

Parameters:

uuid - UUID of the instance

Returns:

the instance with the given UUID, null if not found