Class HighlightedBlockSpawner

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.api.HighlightedBlockSpawner

Direct Known Subclasses:

HighlightedBlockSpawnerSpigot

public abstract class HighlightedBlockSpawner
extends Object

Represents a highlighted animated block. These can be useful for highlighting locations and structures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HighlightedBlockSpawner.Builder	The default builder implementation for highlighted blocks.

Constructor Summary

Constructors

Constructor	Description
HighlightedBlockSpawner()

Method Summary

Modifier and Type	Method	Description
HighlightedBlockSpawner.Builder	builder()	Creates a new builder for a highlighted block.
protected abstract IExecutor	getExecutor()
protected abstract Optional<IHighlightedBlock>	spawnHighlightedBlock(IPlayer player, IWorld world, @Nullable Duration duration, RotatedPosition rotatedPosition, Color color)
void	spawnHighlightedBlocks(IStructureConst structure, IPlayer player, @Nullable Duration duration)	Spawns the highlighted blocks required to highlight a structure.
void	spawnHighlightedBlocks(Structure structure, IPlayer player, @Nullable Duration duration)	Spawns the highlighted blocks required to highlight a structure.

Methods inherited from class Object

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

Constructor Details

HighlightedBlockSpawner

public HighlightedBlockSpawner()

Method Details

spawnHighlightedBlock

protected abstract Optional<IHighlightedBlock> spawnHighlightedBlock(IPlayer player,
 IWorld world,
 @Nullable Duration duration,
 RotatedPosition rotatedPosition,
 Color color)

spawnHighlightedBlocks

public void spawnHighlightedBlocks(IStructureConst structure,
 IPlayer player,
 @Nullable Duration duration)

Spawns the highlighted blocks required to highlight a structure.

Parameters:

structure - The structure to highlight.

player - The IPlayer for whom to highlight the structure.

duration - The amount of time the highlighted blocks should be visible for.

spawnHighlightedBlocks

public void spawnHighlightedBlocks(Structure structure,
 IPlayer player,
 @Nullable Duration duration)

Spawns the highlighted blocks required to highlight a structure.

Parameters:

structure - The structure to highlight.

player - The IPlayer for whom to highlight the structure.

duration - The amount of time the highlighted blocks should be visible for.

getExecutor

protected abstract IExecutor getExecutor()

builder

public HighlightedBlockSpawner.Builder builder()

Creates a new builder for a highlighted block.

Returns:

A new builder for a highlighted block.