Interface StructureAnimationRequest.IFactory

Enclosing class:

StructureAnimationRequest

@AssistedFactory
public static interface StructureAnimationRequest.IFactory

The factory interface for creating StructureAnimationRequest instances.

Method Summary

Modifier and Type	Method	Description
StructureAnimationRequest	create(StructureRetriever structureRetriever, StructureActionCause cause, IMessageable messageReceiver, @Nullable IPlayer responsible, @Nullable Double time, boolean skipAnimation, boolean preventPerpetualMovement, StructureActionType actionType, AnimationType animationType)	Creates a new StructureAnimationRequest.

Method Details

create

StructureAnimationRequest create(StructureRetriever structureRetriever,
 StructureActionCause cause,
 IMessageable messageReceiver,
 @Nullable IPlayer responsible,
 @Nullable Double time,
 @Assisted("skipAnimation")
 boolean skipAnimation,
 @Assisted("preventPerpetualMovement")
 boolean preventPerpetualMovement,
 StructureActionType actionType,
 AnimationType animationType)

Creates a new StructureAnimationRequest.

Once created, use StructureAnimationRequest.execute() to submit the request.

Parameters:

structureRetriever - A retriever for the structure for which this toggle request will be created.

Note that the retriever may only specify a single structure. See StructureRetriever.getStructure().

cause - The cause of the movement.

messageReceiver - The receiver for all messages related to the toggle. When no player is available, this should usually be the server (See IAnimatedArchitecturePlatform.getServer()).

responsible - The player responsible for the movement.

time - The duration of the animation in seconds. May be null to use the default time.

skipAnimation - True to skip the animation and move the blocks to their new locations immediately.

preventPerpetualMovement - True to prevent perpetual movement. When perpetual movement is requested but denied via this setting, the animation will still be time-limited.

actionType - The type of movement to apply.

animationType - The type of animation to apply.

Returns:

The new AnimationRequestData.