Package nl.pim16aap2.animatedarchitecture.core.structures

Class StructureAnimationRequestBuilder.Builder

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.structures.StructureAnimationRequestBuilder.Builder

All Implemented Interfaces:

StructureAnimationRequestBuilder.IBuilder, StructureAnimationRequestBuilder.IBuilderStructure, StructureAnimationRequestBuilder.IBuilderStructureActionCause, StructureAnimationRequestBuilder.IBuilderStructureActionType

Enclosing class:

StructureAnimationRequestBuilder

public static final class StructureAnimationRequestBuilder.Builder
extends Object
implements StructureAnimationRequestBuilder.IBuilderStructure, StructureAnimationRequestBuilder.IBuilderStructureActionCause, StructureAnimationRequestBuilder.IBuilderStructureActionType, StructureAnimationRequestBuilder.IBuilder

Constructor Summary

Constructors

Constructor	Description
Builder(StructureAnimationRequest.IFactory structureToggleRequestFactory, IMessageable messageableServer, IPlayerFactory playerFactory, IConfig config)

Method Summary

Modifier and Type	Method	Description
StructureAnimationRequestBuilder.IBuilder	animationType(AnimationType animationType)	Sets the animation type of the animation.
StructureAnimationRequest	build()	Constructs the new structure toggle request.
StructureAnimationRequestBuilder.IBuilder	messageReceiver(IMessageable messageReceiver)	Optional: Sets the message receiver of the toggle request.
StructureAnimationRequestBuilder.IBuilder	messageReceiverServer()	See StructureAnimationRequestBuilder.IBuilder.messageReceiver(IMessageable).
StructureAnimationRequestBuilder.IBuilder	preventPerpetualMovement(boolean preventPerpetualMovement)	Sets if perpetual movement should be blocked.
StructureAnimationRequestBuilder.IBuilder	responsible(@Nullable IPlayer responsible)	Sets the player responsible for the toggle.
StructureAnimationRequestBuilder.IBuilder	responsible(@Nullable PlayerData playerData)	See StructureAnimationRequestBuilder.IBuilder.responsible(IPlayer).
StructureAnimationRequestBuilder.IBuilder	responsible(@Nullable StructureOwner structureOwner)	See StructureAnimationRequestBuilder.IBuilder.responsible(IPlayer).
StructureAnimationRequestBuilder.IBuilder	skipAnimation(boolean skip)	Optional: Skips the animation.
StructureAnimationRequestBuilder.IBuilderStructureActionCause	structure(StructureRetriever structureRetriever)	Sets the target structure to toggle.
StructureAnimationRequestBuilder.IBuilderStructureActionType	structureActionCause(StructureActionCause structureActionCause)	Sets what caused this toggle request.
StructureAnimationRequestBuilder.IBuilder	structureActionType(StructureActionType structureActionType)	Sets the type of action to request of the structure.
StructureAnimationRequestBuilder.IBuilder	time(@Nullable Double time)	Optional: Sets the time value of the toggle request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.StructureAnimationRequestBuilder.IBuilder

preventPerpetualMovement, skipAnimation

Methods inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.StructureAnimationRequestBuilder.IBuilderStructure

structure, structure

Constructor Details

Builder

public Builder(StructureAnimationRequest.IFactory structureToggleRequestFactory,
 IMessageable messageableServer,
 IPlayerFactory playerFactory,
 IConfig config)

Method Details

time

public StructureAnimationRequestBuilder.IBuilder time(@Nullable
 @Nullable Double time)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Optional: Sets the time value of the toggle request.

Specified by:

time in interface StructureAnimationRequestBuilder.IBuilder

Parameters:

time - The duration (in seconds) of the toggle animation. Because the maximum speed of the animated blocks is limited, there is a lower bound limit of this value. The exact limit depends on the type and dimensions of the structure.

A value of null (default) allows the structure to figure out the time on its own.

Returns:

The next step of the guided builder process.

skipAnimation

public StructureAnimationRequestBuilder.IBuilder skipAnimation(boolean skip)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Optional: Skips the animation.

If this method is called, the animation will be skipped, and the blocks will be moved from their old positions to the new ones immediately. This allows toggling structures without spawning any entities.

This is useful for when there aren't any players nearby to witness the animation anyway, as opening the structure without playing the animation avoids the heavy performance impact of spawning and animating entities.

Specified by:

skipAnimation in interface StructureAnimationRequestBuilder.IBuilder

Returns:

The next step of the guided builder process.

preventPerpetualMovement

public StructureAnimationRequestBuilder.IBuilder preventPerpetualMovement(boolean preventPerpetualMovement)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Sets if perpetual movement should be blocked. When perpetual movement is requested but denied via this setting, the animation will still be time-limited.

Specified by:

preventPerpetualMovement in interface StructureAnimationRequestBuilder.IBuilder

Parameters:

preventPerpetualMovement - True to prevent any perpetual movement.

Returns:

The next step of the guided builder process.

responsible

public StructureAnimationRequestBuilder.IBuilder responsible(@Nullable
 @Nullable IPlayer responsible)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Sets the player responsible for the toggle. When the toggle was not caused by a player this value is optional.

However, this value is required if the toggle was caused by a player.

When the toggle request was not caused by a player (e.g. via redstone) and this value is not set, it will default to the prime owner of the structure.

Specified by:

responsible in interface StructureAnimationRequestBuilder.IBuilder

Parameters:

responsible - The player responsible for the toggle request. The responsible player's build-permissions are used for things like checking access to certain areas.

Returns:

The next step of the guided builder process.

responsible

public StructureAnimationRequestBuilder.IBuilder responsible(@Nullable
 @Nullable PlayerData playerData)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

See StructureAnimationRequestBuilder.IBuilder.responsible(IPlayer).

Specified by:

responsible in interface StructureAnimationRequestBuilder.IBuilder

responsible

public StructureAnimationRequestBuilder.IBuilder responsible(@Nullable
 @Nullable StructureOwner structureOwner)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

See StructureAnimationRequestBuilder.IBuilder.responsible(IPlayer).

Specified by:

responsible in interface StructureAnimationRequestBuilder.IBuilder

messageReceiver

public StructureAnimationRequestBuilder.IBuilder messageReceiver(IMessageable messageReceiver)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Optional: Sets the message receiver of the toggle request. The message receiver will receive all messages related to the toggle request.

When the toggle request is caused by a player, this defaults to that player. In all other situations, it defaults to the server (See IAnimatedArchitecturePlatform.getServer()).

Specified by:

messageReceiver in interface StructureAnimationRequestBuilder.IBuilder

Parameters:

messageReceiver - The message receiver for all messages related to the toggle request.

Returns:

The next step of the guided builder process.

messageReceiverServer

public StructureAnimationRequestBuilder.IBuilder messageReceiverServer()

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

See StructureAnimationRequestBuilder.IBuilder.messageReceiver(IMessageable).

Sets the server to be the message receiver.

Specified by:

messageReceiverServer in interface StructureAnimationRequestBuilder.IBuilder

structureActionType

public StructureAnimationRequestBuilder.IBuilder structureActionType(StructureActionType structureActionType)

Description copied from interface: StructureAnimationRequestBuilder.IBuilderStructureActionType

Sets the type of action to request of the structure.

Specified by:

structureActionType in interface StructureAnimationRequestBuilder.IBuilderStructureActionType

Parameters:

structureActionType - The type of action to request.

Returns:

The next step of the guided builder process.

structureActionCause

public StructureAnimationRequestBuilder.IBuilderStructureActionType structureActionCause(StructureActionCause structureActionCause)

Description copied from interface: StructureAnimationRequestBuilder.IBuilderStructureActionCause

Sets what caused this toggle request.

Specified by:

structureActionCause in interface StructureAnimationRequestBuilder.IBuilderStructureActionCause

Parameters:

structureActionCause - The cause of the toggle request.

Returns:

The next step of the guided builder process.

structure

public StructureAnimationRequestBuilder.IBuilderStructureActionCause structure(StructureRetriever structureRetriever)

Description copied from interface: StructureAnimationRequestBuilder.IBuilderStructure

Sets the target structure to toggle.

Specified by:

structure in interface StructureAnimationRequestBuilder.IBuilderStructure

Parameters:

structureRetriever - A retriever for the structure to toggle.

Returns:

The next step of the guided builder process.

animationType

public StructureAnimationRequestBuilder.IBuilder animationType(AnimationType animationType)

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Sets the animation type of the animation. Defaults to AnimationType.MOVE_BLOCKS.

Specified by:

animationType in interface StructureAnimationRequestBuilder.IBuilder

Parameters:

animationType - The animation type to apply.

Returns:

The next step of the guided builder process.

build

public StructureAnimationRequest build()

Description copied from interface: StructureAnimationRequestBuilder.IBuilder

Constructs the new structure toggle request.

Specified by:

build in interface StructureAnimationRequestBuilder.IBuilder

Returns:

The new StructureAnimationRequest.