Package net.minestom.server.instance

Class SharedInstance

java.lang.Object

net.minestom.server.instance.Instance

net.minestom.server.instance.SharedInstance

All Implemented Interfaces:

DataContainer, EventHandler, BlockModifier

public class SharedInstance
extends Instance

The SharedInstance is an instance that shares the same chunks as its linked InstanceContainer, entities are separated.

Field Summary

Fields inherited from class net.minestom.server.instance.Instance

BLOCK_MANAGER, chunkEntities, creatures, entities, experienceOrbs, nextTick, objectEntities, players, uniqueId, UPDATE_MANAGER

Constructor Summary

Constructors

Constructor	Description
SharedInstance(java.util.UUID uniqueId, InstanceContainer instanceContainer)

Method Summary

Modifier and Type	Method	Description
boolean	breakBlock(Player player, BlockPosition blockPosition)	Does call PlayerBlockBreakEvent and send particle packets
BlockBatch	createBlockBatch()	Creates a new BlockBatch linked to this instance.
protected void	createChunk(int chunkX, int chunkZ, ChunkCallback callback)	Called to generated a new Chunk from scratch.
ChunkBatch	createChunkBatch(Chunk chunk)	Creates a new Chunk batch linked to this instance and the specified chunk.
void	enableAutoChunkLoad(boolean enable)	When set to true, chunks will load automatically when requested.
Chunk	getChunk(int chunkX, int chunkZ)	Gets the loaded Chunk at a position.
ChunkGenerator	getChunkGenerator()	Gets the instance ChunkGenerator.
java.util.Collection<Chunk>	getChunks()	Gets all the instance's chunks.
InstanceContainer	getInstanceContainer()	Gets the InstanceContainer from where this instance takes its chunks from.
StorageLocation	getStorageLocation()	Gets the instance StorageLocation.
boolean	hasEnabledAutoChunkLoad()	Gets if the instance should auto load chunks.
boolean	isInVoid(Position position)	Determines whether a position in the void.
void	loadChunk(int chunkX, int chunkZ, ChunkCallback callback)	Forces the generation of a Chunk, even if no file and ChunkGenerator are defined.
void	loadOptionalChunk(int chunkX, int chunkZ, ChunkCallback callback)	Loads the chunk if the chunk is already loaded or if Instance.hasEnabledAutoChunkLoad() returns true.
void	refreshBlockStateId(BlockPosition blockPosition, short blockStateId)	Used to change the id of the block in a specific BlockPosition.
void	retrieveChunk(int chunkX, int chunkZ, ChunkCallback callback)	Used when a Chunk is not currently loaded in memory and need to be retrieved from somewhere else.
void	saveChunksToStorage(java.lang.Runnable callback)	Saves multiple chunks to permanent storage.
void	saveChunkToStorage(Chunk chunk, java.lang.Runnable callback)	Saves a Chunk to permanent storage.
void	scheduleUpdate(int time, TimeUnit unit, BlockPosition position)	Schedules a block update at a given BlockPosition.
void	setBlockStateId(int x, int y, int z, short blockStateId, Data data)	Sets a block at a position.
void	setChunkGenerator(ChunkGenerator chunkGenerator)	Changes the instance ChunkGenerator.
void	setCustomBlock(int x, int y, int z, short customBlockId, Data data)	Sets a CustomBlock at a position.
void	setSeparateBlocks(int x, int y, int z, short blockStateId, short customBlockId, Data data)	Sets a CustomBlock at a position with a custom state id.
void	setStorageLocation(StorageLocation storageLocation)	Changes the instance StorageLocation.
void	unloadChunk(Chunk chunk)	Schedules the removal of a Chunk, this method does not promise when it will be done.

Methods inherited from class net.minestom.server.instance.Instance

addEntityToChunk, explode, explode, getBlockData, getBlockData, getBlockStateId, getBlockStateId, getBlockStateId, getChunkAt, getChunkAt, getChunkAt, getChunkEntities, getCreatures, getCustomBlock, getCustomBlock, getData, getDimensionType, getEntities, getEventCallbacksMap, getExperienceOrbs, getExplosionSupplier, getInstanceSpace, getObjectEntities, getPlayers, getTime, getTimeRate, getTimeUpdate, getUniqueId, getWorldAge, getWorldBorder, isChunkLoaded, isRegistered, loadChunk, loadChunk, loadOptionalChunk, refreshBlockId, refreshBlockId, refreshBlockStateId, removeEntityFromChunk, saveChunksToStorage, saveChunkToStorage, scheduleNextTick, sendBlockAction, setBlockData, setBlockData, setData, setExplosionSupplier, setRegistered, setTime, setTimeRate, setTimeUpdate, tick, unloadChunk, UNSAFE_addEntity, UNSAFE_removeEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.instance.BlockModifier

setBlock, setBlock, setBlockStateId, setBlockStateId, setCustomBlock, setCustomBlock, setCustomBlock, setCustomBlock, setSeparateBlocks, setSeparateBlocks

Methods inherited from interface net.minestom.server.event.handler.EventHandler

addEventCallback, callCancellableEvent, callEvent, getEventCallbacks, getEventCallbacks, removeEventCallback

Constructor Details

SharedInstance

public SharedInstance(@NotNull java.util.UUID uniqueId, @NotNull InstanceContainer instanceContainer)

Method Details

refreshBlockStateId

public void refreshBlockStateId(@NotNull BlockPosition blockPosition, short blockStateId)

Description copied from class: Instance

Used to change the id of the block in a specific BlockPosition.

In case of a CustomBlock it does not remove it but only refresh its visual.

Specified by:

refreshBlockStateId in class Instance

Parameters:

blockPosition - the block position

blockStateId - the new block state

breakBlock

public boolean breakBlock(@NotNull Player player, @NotNull BlockPosition blockPosition)

Description copied from class: Instance

Does call PlayerBlockBreakEvent and send particle packets

Specified by:

breakBlock in class Instance

Parameters:

player - the Player who break the block

blockPosition - the BlockPosition of the broken block

Returns:

true if the block has been broken, false if it has been cancelled

loadChunk

public void loadChunk(int chunkX, int chunkZ, @Nullable ChunkCallback callback)

Description copied from class: Instance

Forces the generation of a Chunk, even if no file and ChunkGenerator are defined.

Specified by:

loadChunk in class Instance

Parameters:

chunkX - the chunk X

chunkZ - the chunk Z

callback - optional consumer called after the chunk has been generated, the returned chunk will never be null

loadOptionalChunk

public void loadOptionalChunk(int chunkX, int chunkZ, @Nullable ChunkCallback callback)

Description copied from class: Instance

Loads the chunk if the chunk is already loaded or if Instance.hasEnabledAutoChunkLoad() returns true.

Specified by:

loadOptionalChunk in class Instance

Parameters:

chunkX - the chunk X

chunkZ - the chunk Z

callback - optional consumer called after the chunk has tried to be loaded, contains a chunk if it is successful, null otherwise

unloadChunk

public void unloadChunk(@NotNull Chunk chunk)

Description copied from class: Instance

Schedules the removal of a Chunk, this method does not promise when it will be done.

WARNING: during unloading, all entities other than Player will be removed.

For InstanceContainer it is done during the next InstanceContainer.tick(long).

Specified by:

unloadChunk in class Instance

Parameters:

chunk - the chunk to unload

getChunk

public Chunk getChunk(int chunkX, int chunkZ)

Description copied from class: Instance

Gets the loaded Chunk at a position.

WARNING: this should only return already-loaded chunk, use Instance.loadChunk(int, int) or similar to load one instead.

Specified by:

getChunk in class Instance

Parameters:

chunkX - the chunk X

chunkZ - the chunk Z

Returns:

the chunk at the specified position, null if not loaded

saveChunkToStorage

public void saveChunkToStorage(@NotNull Chunk chunk, @Nullable java.lang.Runnable callback)

Description copied from class: Instance

Saves a Chunk to permanent storage.

Specified by:

saveChunkToStorage in class Instance

Parameters:

chunk - the Chunk to save

callback - optional callback called when the Chunk is done saving

saveChunksToStorage

public void saveChunksToStorage(@Nullable java.lang.Runnable callback)

Description copied from class: Instance

Saves multiple chunks to permanent storage.

Specified by:

saveChunksToStorage in class Instance

Parameters:

callback - optional callback called when the chunks are done saving

createBlockBatch

public BlockBatch createBlockBatch()

Description copied from class: Instance

Creates a new BlockBatch linked to this instance.

Specified by:

createBlockBatch in class Instance

Returns:

a BlockBatch linked to the instance

createChunkBatch

public ChunkBatch createChunkBatch(@NotNull Chunk chunk)

Description copied from class: Instance

Creates a new Chunk batch linked to this instance and the specified chunk.

Specified by:

createChunkBatch in class Instance

Parameters:

chunk - the chunk to modify

Returns:

a ChunkBatch linked to chunk

setChunkGenerator

public void setChunkGenerator(ChunkGenerator chunkGenerator)

Description copied from class: Instance

Changes the instance ChunkGenerator.

Specified by:

setChunkGenerator in class Instance

Parameters:

chunkGenerator - the new ChunkGenerator of the instance

getChunkGenerator

public ChunkGenerator getChunkGenerator()

Description copied from class: Instance

Gets the instance ChunkGenerator.

Specified by:

getChunkGenerator in class Instance

Returns:

the ChunkGenerator of the instance

getChunks

@NotNull public java.util.Collection<Chunk> getChunks()

Description copied from class: Instance

Gets all the instance's chunks.

Specified by:

getChunks in class Instance

Returns:

an unmodifiable containing all the loaded chunks of the instance

getStorageLocation

public StorageLocation getStorageLocation()

Description copied from class: Instance

Gets the instance StorageLocation.

Specified by:

getStorageLocation in class Instance

Returns:

the StorageLocation of the instance

setStorageLocation

public void setStorageLocation(StorageLocation storageLocation)

Description copied from class: Instance

Changes the instance StorageLocation.

Specified by:

setStorageLocation in class Instance

Parameters:

storageLocation - the new StorageLocation of the instance

retrieveChunk

public void retrieveChunk(int chunkX, int chunkZ, @Nullable ChunkCallback callback)

Description copied from class: Instance

Used when a Chunk is not currently loaded in memory and need to be retrieved from somewhere else. Could be read from disk, or generated from scratch.

Be sure to signal the chunk using UpdateManager.signalChunkLoad(Instance, int, int) and to cache that this chunk has been loaded.

WARNING: it has to retrieve a chunk, this is not optional and should execute the callback in all case.

Specified by:

retrieveChunk in class Instance

Parameters:

chunkX - the chunk X

chunkZ - the chunk X

callback - the optional callback executed once the Chunk has been retrieved

createChunk

protected void createChunk(int chunkX, int chunkZ, ChunkCallback callback)

Description copied from class: Instance

Called to generated a new Chunk from scratch.

Be sure to signal the chunk using UpdateManager.signalChunkLoad(Instance, int, int) and to cache that this chunk has been loaded.

This is where you can put your chunk generation code.

Specified by:

createChunk in class Instance

Parameters:

chunkX - the chunk X

chunkZ - the chunk Z

callback - the optional callback executed with the newly created Chunk

enableAutoChunkLoad

public void enableAutoChunkLoad(boolean enable)

Description copied from class: Instance

When set to true, chunks will load automatically when requested. Otherwise using Instance.loadChunk(int, int) will be required to even spawn a player

Specified by:

enableAutoChunkLoad in class Instance

Parameters:

enable - enable the auto chunk load

hasEnabledAutoChunkLoad

public boolean hasEnabledAutoChunkLoad()

Description copied from class: Instance

Gets if the instance should auto load chunks.

Specified by:

hasEnabledAutoChunkLoad in class Instance

Returns:

true if auto chunk load is enabled, false otherwise

isInVoid

public boolean isInVoid(@NotNull Position position)

Description copied from class: Instance

Determines whether a position in the void. If true, entities should take damage and die.

Always returning false allow entities to survive in the void.

Specified by:

isInVoid in class Instance

Parameters:

position - the position in the world

Returns:

true iif position is inside the void

setBlockStateId

public void setBlockStateId(int x, int y, int z, short blockStateId, Data data)

Description copied from interface: BlockModifier

Sets a block at a position.

You can use BlockModifier.setBlock(int, int, int, Block) if you want it to be more explicit.

Parameters:

x - the block X

y - the block Y

z - the block Z

blockStateId - the block state id

data - the block Data, can be null

setCustomBlock

public void setCustomBlock(int x, int y, int z, short customBlockId, Data data)

Description copied from interface: BlockModifier

Sets a CustomBlock at a position.

The custom block id should be the one returned by CustomBlock.getCustomBlockId().

Parameters:

x - the block X

y - the block Y

z - the block Z

customBlockId - the custom block id

data - the block Data, can be null

setSeparateBlocks

public void setSeparateBlocks(int x, int y, int z, short blockStateId, short customBlockId, Data data)

Description copied from interface: BlockModifier

Sets a CustomBlock at a position with a custom state id.

The custom block id should be the one returned by CustomBlock.getCustomBlockId(), and the block state id can be anything you want, state id can be retrieved using Block.getBlockId().

Parameters:

x - the block X

y - the block Y

z - the block Z

blockStateId - the block state id

customBlockId - the custom block id

data - the block Data, can be null

scheduleUpdate

public void scheduleUpdate(int time, @NotNull TimeUnit unit, @NotNull BlockPosition position)

Description copied from class: Instance

Schedules a block update at a given BlockPosition. Does nothing if no CustomBlock is present at position.

Cancelled if the block changes between this call and the actual update.

Specified by:

scheduleUpdate in class Instance

Parameters:

time - in how long this update must be performed?

unit - in what unit is the time expressed

position - the location of the block to update

getInstanceContainer

@NotNull public InstanceContainer getInstanceContainer()

Gets the InstanceContainer from where this instance takes its chunks from.

Returns:

the associated InstanceContainer