Package com.plotsquared.core.setup

Interface SetupStep

All Known Implementing Classes:

CommonSetupSteps, SettingsNodeStep

public interface SetupStep

Method Summary

Modifier and Type	Method	Description
void	announce(PlotPlayer<?> plotPlayer)	Announces this step to the player.
default Collection<Command>	createSuggestions(PlotPlayer<?> plotPlayer, String argument)	Creates a collection of suggestions for the current input.
@Nullable String	getDefaultValue()
@NonNull Collection<String>	getSuggestions()
SetupStep	handleInput(PlotPlayer<?> plotPlayer, PlotAreaBuilder builder, String argument)	Handles the input for this setup step.
default void	onBack(PlotAreaBuilder builder)	This method is called when the SetupProcess reverts to a previous step.

Method Details

handleInput

SetupStep handleInput(PlotPlayer<?> plotPlayer,
 PlotAreaBuilder builder,
 String argument)

Handles the input for this setup step.

Parameters:

plotPlayer - the plot player executing the command

builder - the plot area builder to work on

argument - the argument given as input

Returns:

the next step if input was valid, this setup step otherwise

getSuggestions

@NonNull Collection<String> getSuggestions()

getDefaultValue

@Nullable String getDefaultValue()

announce

void announce(PlotPlayer<?> plotPlayer)

Announces this step to the player.

Parameters:

plotPlayer - the player to announce this step to.

createSuggestions

default Collection<Command> createSuggestions(PlotPlayer<?> plotPlayer,
 String argument)

Creates a collection of suggestions for the current input.

Parameters:

plotPlayer - the player to receive the suggestions.

argument - the argument already typed.

Returns:

a collection of suggestions.

onBack

default void onBack(PlotAreaBuilder builder)

This method is called when the SetupProcess reverts to a previous step.

Parameters:

builder - the builder associated with the setup process.