Package net.minestom.server.instance

Class InstanceManager

java.lang.Object

net.minestom.server.instance.InstanceManager

public final class InstanceManager
extends java.lang.Object

Used to register Instance.

Constructor Summary

Constructors

Constructor	Description
InstanceManager()

Method Summary

Modifier and Type	Method	Description
InstanceContainer	createInstanceContainer()	Creates and register an InstanceContainer.
InstanceContainer	createInstanceContainer(StorageLocation storageLocation)	Creates and register an InstanceContainer with the specified StorageLocation.
InstanceContainer	createInstanceContainer(DimensionType dimensionType)	Creates and register an InstanceContainer with the specified DimensionType.
InstanceContainer	createInstanceContainer(DimensionType dimensionType, StorageLocation storageLocation)	Creates and register an InstanceContainer with the specified DimensionType and StorageLocation.
SharedInstance	createSharedInstance(InstanceContainer instanceContainer)	Creates and register a SharedInstance.
java.util.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()

Method Details

registerInstance

public void registerInstance(@NotNull 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

@NotNull public InstanceContainer createInstanceContainer(@NotNull DimensionType dimensionType, @Nullable StorageLocation storageLocation)

Creates and register an InstanceContainer with the specified DimensionType and StorageLocation.

Parameters:

dimensionType - the DimensionType of the instance

storageLocation - the StorageLocation of the instance, can be null

Returns:

the created InstanceContainer

createInstanceContainer

@NotNull public InstanceContainer createInstanceContainer(@Nullable StorageLocation storageLocation)

Creates and register an InstanceContainer with the specified StorageLocation.

Parameters:

storageLocation - the StorageLocation of the instance, can be null

Returns:

the created InstanceContainer

createInstanceContainer

@NotNull public InstanceContainer createInstanceContainer(@NotNull DimensionType dimensionType)

Creates and register an InstanceContainer with the specified DimensionType.

Parameters:

dimensionType - the DimensionType of the instance

Returns:

the created InstanceContainer

createInstanceContainer

@NotNull public InstanceContainer createInstanceContainer()

Creates and register an InstanceContainer.

Returns:

the created InstanceContainer

registerSharedInstance

@NotNull public SharedInstance registerSharedInstance(@NotNull 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:

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

createSharedInstance

@NotNull public SharedInstance createSharedInstance(@NotNull InstanceContainer instanceContainer)

Creates and register a SharedInstance.

Parameters:

instanceContainer - the container assigned to the shared instance

Returns:

the created SharedInstance

Throws:

java.lang.IllegalStateException - if instanceContainer is not registered

unregisterInstance

public void unregisterInstance(@NotNull Instance instance)

Unregisters the Instance internally.

If instance is an InstanceContainer all chunks are unloaded.

Parameters:

instance - the Instance to unregister

getInstances

@NotNull public java.util.Set<Instance> getInstances()

Gets all the registered instances.

Returns:

an unmodifiable Set containing all the registered instances