src/main/java/org/bukkit/conversations/Conversable.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

package org.bukkit.conversations;

import org.bukkit.command.CommandSender;

/**
 * The Conversable interface is used to indicate objects that can have conversations.
 */
public interface Conversable {

    /**
     * Tests to see of a Conversable object is actively engaged in a conversation.
     * @return True if a conversation is in progress
     */
    public boolean isConversing();

    /**
     * Accepts input into the active conversation. If no conversation is in progress,
     * this method does nothing.
     * @param input The input message into the conversation
     */
    public void acceptConversationInput(String input);

    /**
     * Enters into a dialog with a Conversation object.
     * @param conversation The conversation to begin
     * @return True if the conversation should proceed, false if it has been enqueued
     */
    public boolean beginConversation(Conversation conversation);

    /**
     * Abandons an active conversation.
     * @param conversation The conversation to abandon
     */
    public void abandonConversation(Conversation conversation);

    /**
     * Sends this sender a message raw
     *
     * @param message Message to be displayed
     */
    public void sendRawMessage(String message);
}