Package org.bukkit.conversations

Class FixedSetPrompt

java.lang.Object
org.bukkit.conversations.ValidatingPrompt
org.bukkit.conversations.FixedSetPrompt
All Implemented Interfaces:
Cloneable, Prompt
@Deprecated(forRemoval=true) public abstract class FixedSetPrompt extends ValidatingPrompt
Deprecated, for removal: This API element is subject to removal in a future version.
The conversation API has been deprecated for removal. This system does not support component based messages and has been slowly losing functionality over the years as Minecraft has changed that this API can not adapt to. It is recommended you instead manually listen to the AsyncChatEvent or alternatively using Dialog to get user input.
FixedSetPrompt is the base class for any prompt that requires a fixed set response from the user.

  • Field Details

    • fixedSet

      protected List<String> fixedSet
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • FixedSetPrompt

      public FixedSetPrompt(@NotNull @NotNull String... fixedSet)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 @NotNull ConversationContext context, @NotNull @NotNull String input)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 @NotNull String formatFixedSet()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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