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()

Method Summary

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

@Experimental
@NotNull
public @NotNull InstanceContainer createInstanceContainer(@NotNull
 @NotNull 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

@NotNull
public @NotNull InstanceContainer createInstanceContainer(@NotNull
 @NotNull DimensionType dimensionType)

createInstanceContainer

@Experimental
@NotNull
public @NotNull InstanceContainer createInstanceContainer(@Nullable
 @Nullable IChunkLoader loader)

createInstanceContainer

@NotNull
public @NotNull InstanceContainer createInstanceContainer()

Creates and register an InstanceContainer.

Returns:

the created InstanceContainer

registerSharedInstance

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

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

createSharedInstance

@NotNull
public @NotNull SharedInstance createSharedInstance(@NotNull
 @NotNull 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(@NotNull
 @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 @NotNull Set<@NotNull Instance> getInstances()

Gets all the registered instances.

Returns:

an unmodifiable Set containing all the registered instances

getInstance

@Nullable
public @Nullable Instance getInstance(@NotNull
 @NotNull 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