Package nl.pim16aap2.animatedarchitecture.core.animation

Class AnimatedBlockContainer

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.animation.AnimatedBlockContainer

All Implemented Interfaces:

IAnimatedBlockContainer

public class AnimatedBlockContainer
extends Object
implements IAnimatedBlockContainer

Represents an implementation of IAnimatedBlockContainer for animated blocks that affect the world.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	createAnimatedBlocks(StructureSnapshot snapshot, IAnimationComponent animationComponent)	Attempts to create and spawn the animated blocks for the given input.
boolean	equals(Object o)
List<IAnimatedBlock>	getAnimatedBlocks()	The (unmodifiable) list of animated blocks.
@Nullable AnimationRegion	getAnimationRegion()	Getter for the animation region.
void	handleAnimationCompletion()	Handles the blocks when the animation is completed.
int	hashCode()
void	removeOriginalBlocks()	Removes the original blocks from the world.
void	restoreBlocksOnFailure()	Restores all spawned animated blocks to their original positions.
void	spawnAnimatedBlocks()	Tries to replace the original blocks with the animated blocks in the world.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

createAnimatedBlocks

public boolean createAnimatedBlocks(StructureSnapshot snapshot,
 IAnimationComponent animationComponent)

Description copied from interface: IAnimatedBlockContainer

Attempts to create and spawn the animated blocks for the given input.

Specified by:

createAnimatedBlocks in interface IAnimatedBlockContainer

Parameters:

snapshot - The snapshot of the structure to create the animated blocks for.

animationComponent - The animation component to use for retrieving additional information for the animated blocks.

Returns:

The result of the attempted creation of the animated blocks.

spawnAnimatedBlocks

public void spawnAnimatedBlocks()

Description copied from interface: IAnimatedBlockContainer

Tries to replace the original blocks with the animated blocks in the world.

This method also handles the removal of the original blocks.

Specified by:

spawnAnimatedBlocks in interface IAnimatedBlockContainer

removeOriginalBlocks

public void removeOriginalBlocks()

Description copied from interface: IAnimatedBlockContainer

Removes the original blocks from the world.

This method does not have to be called when spawning the animated blocks using IAnimatedBlockContainer.spawnAnimatedBlocks().

Specified by:

removeOriginalBlocks in interface IAnimatedBlockContainer

restoreBlocksOnFailure

public void restoreBlocksOnFailure()

Description copied from interface: IAnimatedBlockContainer

Restores all spawned animated blocks to their original positions.

Should be used in case something failed.

Specified by:

restoreBlocksOnFailure in interface IAnimatedBlockContainer

handleAnimationCompletion

public void handleAnimationCompletion()

Description copied from interface: IAnimatedBlockContainer

Handles the blocks when the animation is completed.

For the most common use-case, this means that the animated blocks will be killed and the blocks they represented will be placed in their final positions.

Specified by:

handleAnimationCompletion in interface IAnimatedBlockContainer

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getAnimatedBlocks

public List<IAnimatedBlock> getAnimatedBlocks()

The (unmodifiable) list of animated blocks.

Specified by:

getAnimatedBlocks in interface IAnimatedBlockContainer

Returns:

All the animated blocks that are part of the animation. In case an error occurred during the creation, this will contain all the animated blocks that have been created up to the point that the problem occurred.

getAnimationRegion

@Nullable
public @Nullable AnimationRegion getAnimationRegion()

Description copied from interface: IAnimatedBlockContainer

Getter for the animation region.

Specified by:

getAnimationRegion in interface IAnimatedBlockContainer

Returns:

The animation region.