Package org.bukkit.conversations

Class ExactMatchConversationCanceller

java.lang.Object
org.bukkit.conversations.ExactMatchConversationCanceller
All Implemented Interfaces:
Cloneable, ConversationCanceller
@Deprecated(forRemoval=true) public class ExactMatchConversationCanceller extends Object implements ConversationCanceller
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.
An ExactMatchConversationCanceller cancels a conversation if the user enters an exact input string

  • Constructor Details

    • ExactMatchConversationCanceller

      public ExactMatchConversationCanceller(@NotNull @NotNull String escapeSequence)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Builds an ExactMatchConversationCanceller.
      Parameters:
      escapeSequence - The string that, if entered by the user, will cancel the conversation.

  • Method Details

    • setConversation

      public void setConversation(@NotNull @NotNull Conversation conversation)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ConversationCanceller
      Sets the conversation this ConversationCanceller can optionally cancel.
      Specified by:
      setConversation in interface ConversationCanceller
      Parameters:
      conversation - A conversation.

    • cancelBasedOnInput

      public boolean cancelBasedOnInput(@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 interface: ConversationCanceller
      Cancels a conversation based on user input.
      Specified by:
      cancelBasedOnInput in interface ConversationCanceller
      Parameters:
      context - Context information about the conversation.
      input - The input text from the user.
      Returns:
      True to cancel the conversation, False otherwise.

    • clone

      @NotNull public @NotNull ConversationCanceller clone()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ConversationCanceller
      Allows the ConversationFactory to duplicate this ConversationCanceller when creating a new Conversation.

      Implementing this method should reset any internal object state.

      Specified by:
      clone in interface ConversationCanceller
      Overrides:
      clone in class Object
      Returns:
      A clone.