Package net.minestom.server.instance

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. Lighting is only updated when a chunk is sent to the client. Updates can be forced using relight(net.minestom.server.instance.Instance, java.util.Collection<net.minestom.server.instance.Chunk>).

Nested Class Summary

Nested classes/interfaces inherited from interface net.minestom.server.instance.block.Block.Getter

Block.Getter.Condition

Field Summary

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

entries, sections, tickableMap

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

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

Constructor Summary

Constructors

Constructor	Description
LightingChunk(@NotNull Instance instance, int chunkX, int chunkZ)

Method Summary

Modifier and Type	Method	Description
protected org.jglrxavpok.hephaistos.nbt.NBTCompound	computeHeightmap()
@NotNull Chunk	copy(@NotNull 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()
int[]	getHeightmap()
boolean	isLightingCalculated()
protected void	onLoad()	Called when the chunk has been successfully loaded.
static void	relight(Instance instance, Collection<Chunk> chunks)	Forces a relight of the specified chunks.
void	sendLighting()
void	setBlock(int x, int y, int z, @NotNull Block block, BlockHandler.Placement placement, BlockHandler.Destroy destroy)

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

getBiome, getBlock, getFullDataPacket, getLastChangeTime, getSection, getSections, reset, setBiome, tick, updateSnapshot

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.world.biomes.Biome.Getter

getBiome

Methods inherited from interface net.minestom.server.world.biomes.Biome.Setter

setBiome

Methods inherited from interface net.minestom.server.instance.block.Block.Getter

getBlock, getBlock, getBlock

Methods inherited from interface net.minestom.server.instance.block.Block.Setter

setBlock

Methods inherited from interface net.minestom.server.tag.Taggable

getTag, hasTag, removeTag, setTag

Methods inherited from interface net.minestom.server.Viewable

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

Constructor Details

LightingChunk

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

Method Details

setBlock

public void setBlock(int x,
 int y,
 int z,
 @NotNull
 @NotNull 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

isLightingCalculated

public boolean isLightingCalculated()

computeHeightmap

protected org.jglrxavpok.hephaistos.nbt.NBTCompound computeHeightmap()

Overrides:

computeHeightmap in class DynamicChunk

getHeightmap

public int[] getHeightmap()

createLightData

protected LightData createLightData()

Overrides:

createLightData in class DynamicChunk

relight

public static void 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

copy

@NotNull
public @NotNull Chunk copy(@NotNull
 @NotNull 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