summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/bukkit/conversations/Conversable.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/bukkit/conversations/Conversable.java')
-rw-r--r--src/main/java/org/bukkit/conversations/Conversable.java5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/main/java/org/bukkit/conversations/Conversable.java b/src/main/java/org/bukkit/conversations/Conversable.java
index 4b6b568e..52b80b6d 100644
--- a/src/main/java/org/bukkit/conversations/Conversable.java
+++ b/src/main/java/org/bukkit/conversations/Conversable.java
@@ -9,6 +9,7 @@ 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();
@@ -16,12 +17,14 @@ public interface Conversable {
/**
* 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
*/
@@ -29,12 +32,14 @@ public interface Conversable {
/**
* Abandons an active conversation.
+ *
* @param conversation The conversation to abandon
*/
public void abandonConversation(Conversation conversation);
/**
* Abandons an active conversation.
+ *
* @param conversation The conversation to abandon
* @param details Details about why the conversation was abandoned
*/