Class LightingChunk

java.lang.Object

net.minestom.server.instance.Chunk

net.minestom.server.instance.DynamicChunk

net.minestom.server.instance.LightingChunk

All Implemented Interfaces:

Block.Getter, Block.Setter, Snapshotable, Taggable, TagReadable, TagWritable, Tickable, Viewable, Biome.Getter, Biome.Setter

public class LightingChunk
extends DynamicChunk

A chunk which supports lighting computation.

This chunk is used to compute the light data for each block.

Nested Class Summary

Nested classes/interfaces inherited from interface Block.Getter

Block.Getter.Condition

Field Summary

Fields inherited from class DynamicChunk

entries, motionBlocking, sections, tickableMap, worldSurface

Fields inherited from class Chunk

CHUNK_SECTION_SIZE, CHUNK_SIZE_X, CHUNK_SIZE_Z, chunkX, chunkZ, instance, loaded, maxSection, minSection

Constructor Summary

Constructors

Modifier	Constructor	Description
	LightingChunk(Instance instance, int chunkX, int chunkZ)
protected	LightingChunk(Instance instance, int chunkX, int chunkZ, List<Section> sections)

Method Summary

Modifier and Type	Method	Description
Chunk	copy(Instance instance, int chunkX, int chunkZ)	Creates a copy of this chunk, including blocks state id, custom block id, biomes, update data.
protected LightData	createLightData(boolean requiredFullChunk)
int[]	getOcclusionMap()
void	invalidate()	Invalidate the chunk caches
void	invalidateNeighborsSection(int coordinate)
void	invalidateResendDelay()
boolean	isLoaded()	Used to verify if the chunk should still be kept in memory.
void	onGenerate()	Called when the chunk generator has finished generating the chunk.
protected void	onLoad()	Called when the chunk has been successfully loaded.
static List<Chunk>	relight(Instance instance, Collection<Chunk> chunks)	Forces a relight of the specified chunks.
void	sendLighting()
void	setBlock(int x, int y, int z, Block block, BlockHandler.Placement placement, BlockHandler.Destroy destroy)
void	setFreezeInvalidation(boolean freezeInvalidation)
void	tick(long time)	Executes a chunk tick.

Methods inherited from class DynamicChunk

getBiome, getBlock, getFullDataPacket, getHeightmaps, getSection, getSections, loadHeightmapsFromNBT, motionBlockingHeightmap, reset, setBiome, updateSnapshot, worldSurfaceHeightmap

Methods inherited from class Chunk

addViewer, getChunkX, getChunkZ, getIdentifier, getInstance, getMaxSection, getMinSection, getSectionAt, getViewers, isReadOnly, removeViewer, sendChunk, sendChunk, setBlock, setReadOnly, shouldGenerate, tagHandler, toPosition, toString, unload

Methods inherited from class Object

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

Methods inherited from interface Biome.Getter

getBiome

Methods inherited from interface Biome.Setter

setBiome

Methods inherited from interface Block.Getter

getBlock, getBlock, getBlock

Methods inherited from interface Block.Setter

setBlock, setBlockArea

Methods inherited from interface Taggable

getAndSetTag, getAndUpdateTag, getTag, hasTag, removeTag, setTag, updateAndGetTag, updateTag

Methods inherited from interface Viewable

getViewersAsAudience, getViewersAsAudiences, isViewer, sendPacketsToViewers, sendPacketsToViewers, sendPacketToViewers, sendPacketToViewersAndSelf

Constructor Details

LightingChunk

public LightingChunk(Instance instance,
 int chunkX,
 int chunkZ)

LightingChunk

protected LightingChunk(Instance instance,
 int chunkX,
 int chunkZ,
 List<Section> sections)

Method Details

invalidate

public void invalidate()

Description copied from class: Chunk

Invalidate the chunk caches

Overrides:

invalidate in class DynamicChunk

setFreezeInvalidation

public void setFreezeInvalidation(boolean freezeInvalidation)

invalidateNeighborsSection

public void invalidateNeighborsSection(int coordinate)

invalidateResendDelay

public void invalidateResendDelay()

setBlock

public void setBlock(int x,
 int y,
 int z,
 Block block,
 @Nullable
 BlockHandler.Placement placement,
 @Nullable
 BlockHandler.Destroy destroy)

Overrides:

setBlock in class DynamicChunk

sendLighting

public void sendLighting()

onLoad

protected void onLoad()

Description copied from class: Chunk

Called when the chunk has been successfully loaded.

Overrides:

onLoad in class Chunk

onGenerate

public void onGenerate()

Description copied from class: Chunk

Called when the chunk generator has finished generating the chunk.

Overrides:

onGenerate in class Chunk

getOcclusionMap

public int[] getOcclusionMap()

createLightData

protected LightData createLightData(boolean requiredFullChunk)

Overrides:

createLightData in class DynamicChunk

tick

public void tick(long time)

Description copied from class: Chunk

Executes a chunk tick.

Should be used to update all the blocks in the chunk.

WARNING: this method doesn't necessary have to be thread-safe, proceed with caution.

Specified by:

tick in interface Tickable

Overrides:

tick in class DynamicChunk

Parameters:

time - the time of the update in milliseconds

relight

public static List<Chunk> relight(Instance instance,
 Collection<Chunk> chunks)

Forces a relight of the specified chunks.

This method is used to force a relight of the specified chunks.

This method is thread-safe and can be called from any thread.

Parameters:

instance - the instance

chunks - the chunks to relight

Returns:

the chunks which have been relighted

copy

public Chunk copy(Instance instance,
 int chunkX,
 int chunkZ)

Description copied from class: Chunk

Creates a copy of this chunk, including blocks state id, custom block id, biomes, update data.

The chunk position (X/Z) can be modified using the given arguments.

Overrides:

copy in class DynamicChunk

Parameters:

instance - the chunk owner

chunkX - the chunk X of the copy

chunkZ - the chunk Z of the copy

Returns:

a copy of this chunk with a potentially new instance and position

isLoaded

public boolean isLoaded()

Description copied from class: Chunk

Used to verify if the chunk should still be kept in memory.

Overrides:

isLoaded in class Chunk

Returns:

true if the chunk is loaded