Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here. By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -3,20 +3,22 @@ package org.bukkit.conversations;
|
||||
import org.bukkit.command.CommandSender;
|
||||
|
||||
/**
|
||||
* The Conversable interface is used to indicate objects that can have conversations.
|
||||
* 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.
|
||||
* 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.
|
||||
* Accepts input into the active conversation. If no conversation is in
|
||||
* progress, this method does nothing.
|
||||
*
|
||||
* @param input The input message into the conversation
|
||||
*/
|
||||
@@ -26,7 +28,8 @@ public interface Conversable {
|
||||
* 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
|
||||
* @return True if the conversation should proceed, false if it has been
|
||||
* enqueued
|
||||
*/
|
||||
public boolean beginConversation(Conversation conversation);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user