Package nl.pim16aap2.animatedarchitecture.core.api

Class HighlightedBlockSpawner.Builder

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.api.HighlightedBlockSpawner.Builder

Enclosing class:

HighlightedBlockSpawner

public static final class HighlightedBlockSpawner.Builder
extends Object

The default builder implementation for highlighted blocks.

Method Summary

Modifier and Type	Method	Description
HighlightedBlockSpawner.Builder	atLocation(ILocation location)
HighlightedBlockSpawner.Builder	atPosition(double x, double y, double z)	Sets the x, y, and z coordinates to spawn the highlighted block at.
HighlightedBlockSpawner.Builder	atPosition(RotatedPosition rotatedPosition)	Sets the rotation components of the highlighted block.
HighlightedBlockSpawner.Builder	atPosition(IVector3D position)
HighlightedBlockSpawner.Builder	forDuration(@Nullable Duration duration)
HighlightedBlockSpawner.Builder	forPlayer(IPlayer player)
HighlightedBlockSpawner.Builder	inWorld(IWorld world)
Optional<IHighlightedBlock>	spawn()	Creates and spawns the new highlighted block using the provided configuration.
HighlightedBlockSpawner.Builder	withColor(Color color)
HighlightedBlockSpawner.Builder	withRotation(double x, double y, double z)	Sets the rotation components of the highlighted block.
HighlightedBlockSpawner.Builder	withRotation(IVector3D rotation)	Sets the rotation components of the highlighted block.

Methods inherited from class java.lang.Object

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

Method Details

forPlayer

public HighlightedBlockSpawner.Builder forPlayer(IPlayer player)

Parameters:

player - The player who will see the highlighted block.

atLocation

public HighlightedBlockSpawner.Builder atLocation(ILocation location)

Parameters:

location - The location where the highlighted block will be spawned. This sets the coordinates and the world.

inWorld

public HighlightedBlockSpawner.Builder inWorld(IWorld world)

Parameters:

world - The world the highlighted block will be spawned in.

forDuration

public HighlightedBlockSpawner.Builder forDuration(@Nullable
 @Nullable Duration duration)

Parameters:

duration - The amount of time the highlighted block should exist for after it has been spawned.

atPosition

public HighlightedBlockSpawner.Builder atPosition(IVector3D position)

Parameters:

position - The position to spawn the highlighted block at. This only sets the coordinates; not the world.

atPosition

public HighlightedBlockSpawner.Builder atPosition(double x,
 double y,
 double z)

Sets the x, y, and z coordinates to spawn the highlighted block at.

withRotation

public HighlightedBlockSpawner.Builder withRotation(double x,
 double y,
 double z)

Sets the rotation components of the highlighted block.

withRotation

public HighlightedBlockSpawner.Builder withRotation(IVector3D rotation)

Sets the rotation components of the highlighted block.

atPosition

public HighlightedBlockSpawner.Builder atPosition(RotatedPosition rotatedPosition)

Sets the rotation components of the highlighted block.

withColor

public HighlightedBlockSpawner.Builder withColor(Color color)

Parameters:

color - The color of the highlighted block.

spawn

public Optional<IHighlightedBlock> spawn()

Creates and spawns the new highlighted block using the provided configuration.

Returns:

The IHighlightedBlock that was spawned. The optional will be empty if it could not be spawned for some reason.