Package com.fastasyncworldedit.core.extent

Class OncePerChunkExtent

java.lang.Object

com.sk89q.worldedit.extent.AbstractDelegateExtent

com.fastasyncworldedit.core.extent.OncePerChunkExtent

All Implemented Interfaces:

IBatchProcessor, Extent, InputExtent, OutputExtent

public class OncePerChunkExtent
extends AbstractDelegateExtent
implements IBatchProcessor

Extent/processor that runs a task the first time a chunk GET is loaded

Since:

2.13.0

Field Summary

Fields inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

extent

Constructor Summary

Constructors

Constructor	Description
OncePerChunkExtent(Extent extent, IQueueExtent<IQueueChunk> queue, Consumer<IChunkGet> task)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
@Nullable Extent	construct(Extent child)	Convert this processor into an Extent based processor instead of a queue batch based on.
BiomeType	getBiome(BlockVector3 position)	Get the biome at the given location.
BiomeType	getBiomeType(int x, int y, int z)
BlockState	getBlock(int x, int y, int z)
BlockState	getBlock(BlockVector3 position)	Get a snapshot of the block at the given location.
int	getBrightness(int x, int y, int z)
int	getEmittedLight(int x, int y, int z)
BaseBlock	getFullBlock(int x, int y, int z)
BaseBlock	getFullBlock(BlockVector3 position)	Get an immutable snapshot of the block at the given location.
ProcessorScope	getScope()	Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.
int	getSkyLight(int x, int y, int z)
Consumer<IChunkGet>	getTask()	Get the task run once per chunk.
IChunkGet	processGet(IChunkGet get)	Process a chunk GET.
IChunkSet	processSet(IChunk chunk, IChunkGet get, IChunkSet set)	Process a chunk that has been set.
void	reset()	Reset the chunks visited
boolean	setBiome(int x, int y, int z, BiomeType biome)
boolean	setBiome(BlockVector3 position, BiomeType biome)	Set the biome.
void	setBlockLight(int x, int y, int z, int value)
void	setSkyLight(int x, int y, int z, int value)
void	setTask(Consumer<IChunkGet> task)	Set the task to be run once per chunk

Methods inherited from class com.sk89q.worldedit.extent.AbstractDelegateExtent

addPostProcessor, addProcessor, apply, cancel, commit, commitBefore, countBlocks, countBlocks, createEntity, createEntity, disableHistory, disableQueue, enableQueue, fullySupports3DBiomes, getBlockDistribution, getBlockDistributionWithData, getEntities, getEntities, getExtent, getMaximumPoint, getMaxY, getMinimumPoint, getMinY, isQueueEnabled, isWorld, relight, relightBlock, relightSky, removeEntity, replaceBlocks, replaceBlocks, replaceBlocks, setBlock, setBlock, setBlocks, setBlocks, setBlocks, setChangeSet, tile, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.extent.Extent

addCaves, addOre, addOres, addSchems, apply, center, contains, contains, enableHistory, generate, getHighestTerrainBlock, getHighestTerrainBlock, getNearestSurfaceLayer, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, getNearestSurfaceTerrainBlock, lazyCopy, regenerateChunk, spawnResource

Methods inherited from interface com.fastasyncworldedit.core.queue.IBatchProcessor

flush, join, joinPost, postProcess, postProcessSet, processGet, remove, trimNBT, trimNBT, trimY

Methods inherited from interface com.sk89q.worldedit.extent.InputExtent

getBiome, getBrightness, getEmittedLight, getHeightMap, getOpacity, getOpacity, getSkyLight

Methods inherited from interface com.sk89q.worldedit.extent.OutputExtent

setBiome, setBlockLight, setHeightMap, setSkyLight, setTile

Constructor Details

OncePerChunkExtent

public OncePerChunkExtent(@Nonnull
 Extent extent,
 @Nonnull
 IQueueExtent<IQueueChunk> queue,
 @Nonnull
 Consumer<IChunkGet> task)

Create a new instance.

Parameters:

extent - the extent

queue - Queue to load chunk GET from if acting as extent not processor

task - Consumer task for the chunk GET

Since:

2.13.0

Method Details

getTask

public Consumer<IChunkGet> getTask()

Get the task run once per chunk.

setTask

public void setTask(Consumer<IChunkGet> task)

Set the task to be run once per chunk

processSet

public IChunkSet processSet(IChunk chunk,
 IChunkGet get,
 IChunkSet set)

Description copied from interface: IBatchProcessor

Process a chunk that has been set.

Specified by:

processSet in interface IBatchProcessor

processGet

public IChunkGet processGet(IChunkGet get)

Description copied from interface: IBatchProcessor

Process a chunk GET. Method typically only called when a chunk is loaded into memory (miss from cache).

Specified by:

processGet in interface IBatchProcessor

Parameters:

get - GET chunk loaded

Returns:

processed get chunk

construct

@Nullable
public @Nullable Extent construct(Extent child)

Description copied from interface: IBatchProcessor

Convert this processor into an Extent based processor instead of a queue batch based on.

Specified by:

construct in interface IBatchProcessor

getScope

public ProcessorScope getScope()

Description copied from interface: IBatchProcessor

Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.

Specified by:

getScope in interface IBatchProcessor

getBlock

public BlockState getBlock(BlockVector3 position)

Description copied from interface: InputExtent

Get a snapshot of the block at the given location.

If the given position is out of the bounds of the extent, then the behavior is undefined (an air block could be returned). However, null should not be returned.

The returned block is immutable and is a snapshot of the block at the time of call. It has no position attached to it, so it could be reused in Patterns and so on.

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

getBlock

public BlockState getBlock(int x,
 int y,
 int z)

Specified by:

getBlock in interface InputExtent

Overrides:

getBlock in class AbstractDelegateExtent

getFullBlock

public BaseBlock getFullBlock(BlockVector3 position)

Description copied from interface: InputExtent

Get an immutable snapshot of the block at the given location.

Specified by:

getFullBlock in interface InputExtent

Overrides:

getFullBlock in class AbstractDelegateExtent

Parameters:

position - position of the block

Returns:

the block

getFullBlock

public BaseBlock getFullBlock(int x,
 int y,
 int z)

Specified by:

getFullBlock in interface InputExtent

Overrides:

getFullBlock in class AbstractDelegateExtent

getBiomeType

public BiomeType getBiomeType(int x,
 int y,
 int z)

Specified by:

getBiomeType in interface InputExtent

Overrides:

getBiomeType in class AbstractDelegateExtent

getBiome

public BiomeType getBiome(BlockVector3 position)

Description copied from interface: InputExtent

Get the biome at the given location.

If there is no biome available, then the ocean biome should be returned.

As implementation varies per Minecraft version, this may not exactly get this positions biome. On versions prior to 1.15, this will get the entire column. On later versions it will get the 4x4x4 cube's biome.

Specified by:

getBiome in interface InputExtent

Overrides:

getBiome in class AbstractDelegateExtent

Parameters:

position - the (x, y, z) location to check the biome at

Returns:

the biome at the location

See Also:

• This must be overridden by new subclasses.

getEmittedLight

public int getEmittedLight(int x,
 int y,
 int z)

Specified by:

getEmittedLight in interface InputExtent

Overrides:

getEmittedLight in class AbstractDelegateExtent

getSkyLight

public int getSkyLight(int x,
 int y,
 int z)

Specified by:

getSkyLight in interface InputExtent

Overrides:

getSkyLight in class AbstractDelegateExtent

getBrightness

public int getBrightness(int x,
 int y,
 int z)

Specified by:

getBrightness in interface InputExtent

Overrides:

getBrightness in class AbstractDelegateExtent

setBiome

public boolean setBiome(int x,
 int y,
 int z,
 BiomeType biome)

Specified by:

setBiome in interface OutputExtent

Overrides:

setBiome in class AbstractDelegateExtent

setBiome

public boolean setBiome(BlockVector3 position,
 BiomeType biome)

Description copied from interface: OutputExtent

Set the biome.

As implementation varies per Minecraft version, this may set more than this position's biome. On versions prior to 1.15, this will set the entire column. On later versions it will set the 4x4x4 cube.

Specified by:

setBiome in interface OutputExtent

Overrides:

setBiome in class AbstractDelegateExtent

Parameters:

position - the (x, y, z) location to set the biome at

biome - the biome to set to

Returns:

true if the biome was successfully set (return value may not be accurate)

setBlockLight

public void setBlockLight(int x,
 int y,
 int z,
 int value)

Specified by:

setBlockLight in interface OutputExtent

Overrides:

setBlockLight in class AbstractDelegateExtent

setSkyLight

public void setSkyLight(int x,
 int y,
 int z,
 int value)

Specified by:

setSkyLight in interface OutputExtent

Overrides:

setSkyLight in class AbstractDelegateExtent

reset

public void reset()

Reset the chunks visited