Package org.bukkit.conversations

Class PlayerNamePrompt

java.lang.Object
org.bukkit.conversations.ValidatingPrompt
org.bukkit.conversations.PlayerNamePrompt
All Implemented Interfaces:
Cloneable, Prompt
@Deprecated(forRemoval=true) public abstract class PlayerNamePrompt 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.
PlayerNamePrompt is the base class for any prompt that requires the player to enter another player's name.

  • Constructor Details

    • PlayerNamePrompt

      public PlayerNamePrompt(@NotNull @NotNull Plugin plugin)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • 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.

    • acceptValidatedInput

      @Nullable protected @Nullable Prompt acceptValidatedInput(@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 accept and processes the validated input from the user. Using the input, the next Prompt in the prompt graph should be returned.
      Specified by:
      acceptValidatedInput in class ValidatingPrompt
      Parameters:
      context - Context information about the conversation.
      input - The validated input text from the user.
      Returns:
      The next Prompt in the prompt graph.

    • acceptValidatedInput

      @Nullable protected abstract @Nullable Prompt acceptValidatedInput(@NotNull @NotNull ConversationContext context, @NotNull @NotNull Player input)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Override this method to perform some action with the user's player name response.
      Parameters:
      context - Context information about the conversation.
      input - The user's player name response.
      Returns:
      The next Prompt in the prompt graph.