Class FixedSetPrompt

java.lang.Object
org.bukkit.conversations.ValidatingPrompt
org.bukkit.conversations.FixedSetPrompt
All Implemented Interfaces:
Cloneable, Prompt

public abstract class FixedSetPrompt
extends ValidatingPrompt
FixedSetPrompt is the base class for any prompt that requires a fixed set response from the user.
  • Field Details

  • Constructor Details

    • FixedSetPrompt

      public FixedSetPrompt​(@NotNull String... fixedSet)
      Creates a FixedSetPrompt from a set of strings.

      foo = new FixedSetPrompt("bar", "cheese", "panda");

      Parameters:
      fixedSet - A fixed set of strings, one of which the user must type.
  • Method Details

    • isInputValid

      protected boolean isInputValid​(@NotNull ConversationContext context, @NotNull String input)
      Description copied from class: ValidatingPrompt
      Override this method to check the validity of the player's input.
      Specified by:
      isInputValid in class ValidatingPrompt
      Parameters:
      context - Context information about the conversation.
      input - The player's raw console input.
      Returns:
      True or false depending on the validity of the input.
    • formatFixedSet

      @NotNull protected String formatFixedSet()
      Utility function to create a formatted string containing all the options declared in the constructor.
      Returns:
      the options formatted like "[bar, cheese, panda]" if bar, cheese, and panda were the options used