Package com.plotsquared.core.setup
Interface SetupStep
- All Known Implementing Classes:
CommonSetupSteps
,SettingsNodeStep
public interface SetupStep
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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
@NonNull Collection<String>
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
Handles the input for this setup step.- Parameters:
plotPlayer
- the plot player executing the commandbuilder
- the plot area builder to work onargument
- 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
Announces this step to the player.- Parameters:
plotPlayer
- the player to announce this step to.
-
createSuggestions
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
This method is called when the SetupProcess reverts to a previous step.- Parameters:
builder
- the builder associated with the setup process.
-