Package com.sk89q.worldedit.function.pattern

Interface Pattern

All Superinterfaces:

Filter

All Known Subinterfaces:

BlockStateHolder<B>, ExtentPattern

All Known Implementing Classes:

AbstractExtentPattern, AbstractExtentPattern, AbstractPattern, AngleColorPattern, AnglePattern, AverageColorPattern, BaseBlock, BiomeApplyingPattern, BlanketBaseBlock, BlockPattern, BlockState, BlockType, BufferedPattern, BufferedPattern2D, ClipboardPattern, DesaturatePattern, ExistingPattern, ExpressionPattern, ExtentBufferedCompositePattern, ForgetfulExtentBuffer, FuzzyBlockState, Linear2DBlockPattern, Linear3DBlockPattern, LinearBlockPattern, MaskedPattern, MobSpawnerBlock, NoXPattern, NoYPattern, NoZPattern, OffsetPattern, RandomFullClipboardPattern, RandomOffsetPattern, RandomPattern, RandomStatePattern, RelativePattern, RepeatingExtentPattern, SaturatePattern, ShadePattern, SignBlock, SkullBlock, SolidRandomOffsetPattern, StateApplyingPattern, SurfaceRandomOffsetPattern, TypeApplyingPattern, TypeSwapPattern, WaterloggedRemover

public interface Pattern
extends Filter

Returns a BaseBlock for a given position.

Method Summary

Modifier and Type	Method	Description
default boolean	apply(Extent extent, BlockVector3 get, BlockVector3 set)
default BaseBlock	apply(BlockVector3 position)	Deprecated. use applyBlock(BlockVector3)
default void	applyBlock(FilterBlock block)	Make changes to the block here - e.g., block.setId(...) - Note: Performance is critical here
BaseBlock	applyBlock(BlockVector3 position)	Return a BaseBlock for the given position.
default Pattern	fork()	Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe here
default BlockVector3	size()	Get the likely maximum size of the volume this pattern will affect

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

applyChunk, finishChunk, join

Method Details

apply

@Deprecated
@NonAbstractForCompatibility(delegateName="applyBlock",
                             delegateParams=BlockVector3.class)
default BaseBlock apply(BlockVector3 position)

Deprecated.

use applyBlock(BlockVector3)

Return a BaseBlock for the given position.

Parameters:

position - the position

Returns:

a block

See Also:

• This must be overridden by new subclasses.

apply

default boolean apply(Extent extent,
 BlockVector3 get,
 BlockVector3 set)
               throws WorldEditException

Throws:

WorldEditException

applyBlock

default void applyBlock(FilterBlock block)

Description copied from interface: Filter

Make changes to the block here
- e.g., block.setId(...)
- Note: Performance is critical here

Specified by:

applyBlock in interface Filter

fork

default Pattern fork()

Description copied from interface: Filter

Fork this for use by another thread - Typically filters are simple and don't need to create another copy to be thread safe here

Specified by:

fork in interface Filter

Returns:

this

applyBlock

BaseBlock applyBlock(BlockVector3 position)

Return a BaseBlock for the given position.

Parameters:

position - the position

Returns:

a block

size

default BlockVector3 size()

Get the likely maximum size of the volume this pattern will affect

Returns:

Pattern size

Since:

2.9.2