Package org.bukkit.conversations

Interface ConversationCanceller

All Superinterfaces:
Cloneable
All Known Implementing Classes:
ExactMatchConversationCanceller, InactivityConversationCanceller, ManuallyAbandonedConversationCanceller
@Deprecated(forRemoval=true) public interface ConversationCanceller extends Cloneable
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.
A ConversationCanceller is a class that cancels an active Conversation. A Conversation can have more than one ConversationCanceller.

  • Method Details

    • setConversation

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

    • cancelBasedOnInput

      boolean cancelBasedOnInput(@NotNull @NotNull ConversationContext context, @NotNull @NotNull String input)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Cancels a conversation based on user input.
      Parameters:
      context - Context information about the conversation.
      input - The input text from the user.
      Returns:
      True to cancel the conversation, False otherwise.

    • clone

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

      Implementing this method should reset any internal object state.

      Returns:
      A clone.