Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@@ -11,18 +11,18 @@ import java.util.Map;
|
||||
* The Conversation class is responsible for tracking the current state of a conversation, displaying prompts to
|
||||
* the user, and dispatching the user's response to the appropriate place. Conversation objects are not typically
|
||||
* instantiated directly. Instead a {@link ConversationFactory} is used to construct identical conversations on demand.
|
||||
*
|
||||
* <p>
|
||||
* Conversation flow consists of a directed graph of {@link Prompt} objects. Each time a prompt gets input from the
|
||||
* user, it must return the next prompt in the graph. Since each Prompt chooses the next Prompt, complex conversation
|
||||
* trees can be implemented where the nature of the player's response directs the flow of the conversation.
|
||||
*
|
||||
* <p>
|
||||
* Each conversation has a {@link ConversationPrefix} that prepends all output from the conversation to the player.
|
||||
* The ConversationPrefix can be used to display the plugin name or conversation status as the conversation evolves.
|
||||
*
|
||||
* <p>
|
||||
* Each conversation has a timeout measured in the number of inactive seconds to wait before abandoning the conversation.
|
||||
* If the inactivity timeout is reached, the conversation is abandoned and the user's incoming and outgoing chat is
|
||||
* returned to normal.
|
||||
*
|
||||
* <p>
|
||||
* You should not construct a conversation manually. Instead, use the {@link ConversationFactory} for access to all
|
||||
* available options.
|
||||
*/
|
||||
@@ -40,6 +40,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Initializes a new Conversation.
|
||||
*
|
||||
* @param plugin The plugin that owns this conversation.
|
||||
* @param forWhom The entity for whom this conversation is mediating.
|
||||
* @param firstPrompt The first prompt in the conversation graph.
|
||||
@@ -50,6 +51,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Initializes a new Conversation.
|
||||
*
|
||||
* @param plugin The plugin that owns this conversation.
|
||||
* @param forWhom The entity for whom this conversation is mediating.
|
||||
* @param firstPrompt The first prompt in the conversation graph.
|
||||
@@ -67,6 +69,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Gets the entity for whom this conversation is mediating.
|
||||
*
|
||||
* @return The entity.
|
||||
*/
|
||||
public Conversable getForWhom() {
|
||||
@@ -76,6 +79,7 @@ public class Conversation {
|
||||
/**
|
||||
* Gets the modality of this conversation. If a conversation is modal, all messages directed to the player
|
||||
* are suppressed for the duration of the conversation.
|
||||
*
|
||||
* @return The conversation modality.
|
||||
*/
|
||||
public boolean isModal() {
|
||||
@@ -85,6 +89,7 @@ public class Conversation {
|
||||
/**
|
||||
* Sets the modality of this conversation. If a conversation is modal, all messages directed to the player
|
||||
* are suppressed for the duration of the conversation.
|
||||
*
|
||||
* @param modal The new conversation modality.
|
||||
*/
|
||||
void setModal(boolean modal) {
|
||||
@@ -94,6 +99,7 @@ public class Conversation {
|
||||
/**
|
||||
* Gets the status of local echo for this conversation. If local echo is enabled, any text submitted to a conversation
|
||||
* gets echoed back into the submitter's chat window.
|
||||
*
|
||||
* @return The status of local echo.
|
||||
*/
|
||||
public boolean isLocalEchoEnabled() {
|
||||
@@ -103,6 +109,7 @@ public class Conversation {
|
||||
/**
|
||||
* Sets the status of local echo for this conversation. If local echo is enabled, any text submitted to a conversation
|
||||
* gets echoed back into the submitter's chat window.
|
||||
*
|
||||
* @param localEchoEnabled The status of local echo.
|
||||
*/
|
||||
public void setLocalEchoEnabled(boolean localEchoEnabled) {
|
||||
@@ -111,6 +118,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Gets the {@link ConversationPrefix} that prepends all output from this conversation.
|
||||
*
|
||||
* @return The ConversationPrefix in use.
|
||||
*/
|
||||
public ConversationPrefix getPrefix() {
|
||||
@@ -119,6 +127,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Sets the {@link ConversationPrefix} that prepends all output from this conversation.
|
||||
*
|
||||
* @param prefix The ConversationPrefix to use.
|
||||
*/
|
||||
void setPrefix(ConversationPrefix prefix) {
|
||||
@@ -127,6 +136,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Adds a {@link ConversationCanceller} to the cancellers collection.
|
||||
*
|
||||
* @param canceller The {@link ConversationCanceller} to add.
|
||||
*/
|
||||
void addConversationCanceller(ConversationCanceller canceller) {
|
||||
@@ -136,6 +146,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Gets the list of {@link ConversationCanceller}s
|
||||
*
|
||||
* @return The list.
|
||||
*/
|
||||
public List<ConversationCanceller> getCancellers() {
|
||||
@@ -144,6 +155,7 @@ public class Conversation {
|
||||
|
||||
/**
|
||||
* Returns the Conversation's {@link ConversationContext}.
|
||||
*
|
||||
* @return The ConversationContext.
|
||||
*/
|
||||
public ConversationContext getContext() {
|
||||
|
||||
Reference in New Issue
Block a user