Class StructureAnimationRequest

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.structures.StructureAnimationRequest

public class StructureAnimationRequest
extends Object

Represents the principal way to submit a request to animate a structure.

To submit a new request, first create a new instance using IAnimatedArchitecturePlatform.getStructureAnimationRequestBuilder().

Once the new request has been constructed, it can be submitted using execute().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StructureAnimationRequest.IFactory	The factory interface for creating StructureAnimationRequest instances.

Constructor Summary

Constructors

Constructor

Description

StructureAnimationRequest(StructureRetriever structureRetriever, StructureActionCause cause, IMessageable messageReceiver, @Nullable IPlayer responsible, @Nullable Double time, boolean skipAnimation, boolean preventPerpetualMovement, StructureActionType actionType, AnimationType animationType, ILocalizer localizer, ITextFactory textFactory, StructureActivityManager structureActivityManager, IPlayerFactory playerFactory, IExecutor executor)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<StructureToggleResult>	execute()	Executes the toggle request.
StructureActionType	getActionType()
AnimationType	getAnimationType()
StructureActionCause	getCause()
IExecutor	getExecutor()
ILocalizer	getLocalizer()
IMessageable	getMessageReceiver()
IPlayerFactory	getPlayerFactory()
@Nullable IPlayer	getResponsible()
StructureActivityManager	getStructureActivityManager()
StructureRetriever	getStructureRetriever()
ITextFactory	getTextFactory()
@Nullable Double	getTime()
boolean	isPreventPerpetualMovement()
boolean	isSkipAnimation()
@NonNull String	toString()

Methods inherited from class Object

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

Constructor Details

StructureAnimationRequest

@AssistedInject
public StructureAnimationRequest(@Assisted
 StructureRetriever structureRetriever,
 @Assisted
 StructureActionCause cause,
 @Assisted
 IMessageable messageReceiver,
 @Assisted
 @Nullable IPlayer responsible,
 @Assisted
 @Nullable Double time,
 @Assisted("skipAnimation")
 boolean skipAnimation,
 @Assisted("preventPerpetualMovement")
 boolean preventPerpetualMovement,
 @Assisted
 StructureActionType actionType,
 @Assisted
 AnimationType animationType,
 ILocalizer localizer,
 ITextFactory textFactory,
 StructureActivityManager structureActivityManager,
 IPlayerFactory playerFactory,
 IExecutor executor)

Method Details

execute

public CompletableFuture<StructureToggleResult> execute()

Executes the toggle request.

Returns:

The result of the request.

getLocalizer

public ILocalizer getLocalizer()

getTextFactory

public ITextFactory getTextFactory()

getStructureActivityManager

public StructureActivityManager getStructureActivityManager()

getPlayerFactory

public IPlayerFactory getPlayerFactory()

getExecutor

public IExecutor getExecutor()

toString

public @NonNull String toString()

Overrides:

toString in class Object

getStructureRetriever

public StructureRetriever getStructureRetriever()

getCause

public StructureActionCause getCause()

getMessageReceiver

public IMessageable getMessageReceiver()

getResponsible

public @Nullable IPlayer getResponsible()

getTime

public @Nullable Double getTime()

isSkipAnimation

public boolean isSkipAnimation()

isPreventPerpetualMovement

public boolean isPreventPerpetualMovement()

getActionType

public StructureActionType getActionType()

getAnimationType

public AnimationType getAnimationType()