Package nl.pim16aap2.animatedarchitecture.structures.flag

Class CreatorFlag

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.tooluser.ToolUser

nl.pim16aap2.animatedarchitecture.core.tooluser.creator.Creator

nl.pim16aap2.animatedarchitecture.structures.flag.CreatorFlag

public class CreatorFlag
extends Creator

Nested Class Summary

Nested classes/interfaces inherited from class nl.pim16aap2.animatedarchitecture.core.tooluser.ToolUser

ToolUser.Context

Field Summary

Fields inherited from class nl.pim16aap2.animatedarchitecture.core.tooluser.creator.Creator

commandFactory, databaseManager, economyManager, factoryCompleteProcess, factoryConfirmPrice, factoryProvideFirstPos, factoryProvideName, factoryProvideOpenDir, factoryProvideOpenStatus, factoryProvidePowerBlockPos, factoryProvideRotationPointPos, factoryProvideSecondPos, factoryReviewResult, limitsManager, structureBuilder, structureID, structureType

Fields inherited from class nl.pim16aap2.animatedarchitecture.core.tooluser.ToolUser

animatedArchitectureToolUtil, localizer, protectionHookManager, stepFactory, textFactory, toolUserManager

Constructor Summary

Constructors

Modifier	Constructor	Description
	CreatorFlag(ToolUser.Context context, IPlayer player, @Nullable String name)
protected	CreatorFlag(ToolUser.Context context, StructureType structureType, IPlayer player, @Nullable String name)

Method Summary

Modifier and Type	Method	Description
protected boolean	completeSetRotationPointStep(ILocation loc)	Attempts to complete the step in the Procedure that sets the location of the rotation point for the Structure that is being created.
protected Structure	constructStructure()	Constructs the structure at the end of the creation process.
protected List<Step>	generateSteps()	Generates the list of Steps that together will make up the ToolUser.procedure.
protected void	giveTool()	Method used to give the AnimatedArchitecture tool to the user.
protected final boolean	isNorthSouthAnimated()	Gets whether the flag is animated along the north-south axis.
protected CompletableFuture<Boolean>	provideSecondPos(ILocation loc)	Provides the second location of the selection and advances the procedure if successful.
String	toString()

Methods inherited from class nl.pim16aap2.animatedarchitecture.core.tooluser.creator.Creator

buyStructure, completeCreationProcess, completeNamingStep, completeSetOpenDirStep, completeSetOpenStatusStep, completeSetPowerBlockStep, confirmPrice, constructStructureData, createCuboid, getCuboid, getFirstPos, getMovementDirection, getName, getPowerblock, getPowerBlock, getPrice, getProperty, getRequiredProperty, getStructureArg, getStructureType, getUnregisteredUID, getValidOpenDirections, getWorld, giveTool, init, insertStructure, isLocked, isPowerBlockWithinRangeLimit, isProcessIsUpdatable, prepareReviewResult, prepareSetOpenDirection, prepareSetOpenStatus, provideFirstPos, setCuboid, setFirstPos, setLocked, setMovementDirection, setOpenDirectionTextSupplier, setOpenStatusTextSupplier, setPowerblock, setProperty, setWorld, showPreview, skipConfirmPrice, update, verifyWorldMatch

Methods inherited from class nl.pim16aap2.animatedarchitecture.core.tooluser.ToolUser

abort, assertLockHeld, cleanUpProcess, getAllSteps, getCurrentStep, getCurrentStepMessage, getPlayer, giveTool, goToNextStep, handleInput, handleInputWithLock, insertStep, isActive, playerHasAccessToCuboid, playerHasAccessToLocation, playerHasTool, prepareCurrentStep, removeTool, runWithLock, sendMessage, sendMessage, setPlayerHasTool, skipToStep, toMinimalString

Methods inherited from class java.lang.Object

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

Constructor Details

CreatorFlag

protected CreatorFlag(ToolUser.Context context,
 StructureType structureType,
 IPlayer player,
 @Nullable
 @Nullable String name)

CreatorFlag

public CreatorFlag(ToolUser.Context context,
 IPlayer player,
 @Nullable
 @Nullable String name)

Method Details

generateSteps

protected List<Step> generateSteps()
                            throws InstantiationException

Description copied from class: ToolUser

Generates the list of Steps that together will make up the ToolUser.procedure.

Specified by:

generateSteps in class ToolUser

Returns:

The list of Steps that together will make up the ToolUser.procedure.

Throws:

InstantiationException - When a step's factory is incomplete or otherwise invalid.

giveTool

protected void giveTool()

Description copied from class: Creator

Method used to give the AnimatedArchitecture tool to the user.

Overriding methods may call ToolUser.giveTool(String, String, Text).

Specified by:

giveTool in class Creator

provideSecondPos

protected CompletableFuture<Boolean> provideSecondPos(ILocation loc)

Description copied from class: Creator

Provides the second location of the selection and advances the procedure if successful.

Overrides:

provideSecondPos in class Creator

Parameters:

loc - The second location of the cuboid.

Returns:

True if setting the location was successful.

completeSetRotationPointStep

protected boolean completeSetRotationPointStep(ILocation loc)

Description copied from class: Creator

Attempts to complete the step in the Procedure that sets the location of the rotation point for the Structure that is being created.

Overrides:

completeSetRotationPointStep in class Creator

Parameters:

loc - The selected location of the rotation point.

Returns:

True if the location of the rotation point was set successfully.

constructStructure

protected Structure constructStructure()

Description copied from class: Creator

Constructs the structure at the end of the creation process.

Overrides:

constructStructure in class Creator

Returns:

The newly-created structure.

isNorthSouthAnimated

protected final boolean isNorthSouthAnimated()

Gets whether the flag is animated along the north-south axis.

Returns:

True if the flag is animated along the north-south axis, false otherwise.

toString

public String toString()

Overrides:

toString in class Creator