Package nl.pim16aap2.animatedarchitecture.structures.clock

Class CreatorClock

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.tooluser.ToolUser

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

nl.pim16aap2.animatedarchitecture.structures.clock.CreatorClock

public class CreatorClock
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
	CreatorClock(ToolUser.Context context, IPlayer player, @Nullable String name)
protected	CreatorClock(ToolUser.Context context, StructureType structureType, IPlayer player, @Nullable String name)

Method Summary

Modifier and Type	Method	Description
protected boolean	completeSelectHourArmStep(ILocation loc)	Selects the side of the hour arm that will be the hour arm of the clock.
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 final @Nullable BlockFace	getHourArmSide()
Set<MovementDirection>	getValidOpenDirections()	Gets the list of valid open directions for this type.
protected void	giveTool()	Method used to give the AnimatedArchitecture tool to the user.
protected final boolean	isNorthSouthAligned()
protected CompletableFuture<Boolean>	provideSecondPos(ILocation loc)	Provides the second location of the selection and advances the procedure if successful.
String	toString()
protected void	updateOpenDirection()	Calculates the open direction from the current physical aspects of this clock.

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

buyStructure, completeCreationProcess, completeNamingStep, completeSetOpenDirStep, completeSetOpenStatusStep, completeSetPowerBlockStep, completeSetRotationPointStep, confirmPrice, constructStructureData, createCuboid, getCuboid, getFirstPos, getMovementDirection, getName, getPowerblock, getPowerBlock, getPrice, getProperty, getRequiredProperty, getStructureArg, getStructureType, getUnregisteredUID, 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

CreatorClock

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

CreatorClock

public CreatorClock(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.

completeSelectHourArmStep

protected boolean completeSelectHourArmStep(ILocation loc)

Selects the side of the hour arm that will be the hour arm of the clock.

Parameters:

loc - The selected location.

Returns:

True if step finished successfully.

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.

getValidOpenDirections

public Set<MovementDirection> getValidOpenDirections()

Description copied from class: Creator

Gets the list of valid open directions for this type. It returns a subset of StructureType.getValidMovementDirections() based on the current physical aspects of the Structure.

Overrides:

getValidOpenDirections in class Creator

Returns:

The list of valid open directions for this type given its current physical dimensions.

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

updateOpenDirection

protected void updateOpenDirection()

Calculates the open direction from the current physical aspects of this clock.

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.

getHourArmSide

@Nullable
protected final @Nullable BlockFace getHourArmSide()

isNorthSouthAligned

protected final boolean isNorthSouthAligned()

toString

public String toString()

Overrides:

toString in class Creator