diff options
author | Wesley Wolfe <weswolf@aol.com> | 2012-10-17 04:33:02 -0500 |
---|---|---|
committer | Wesley Wolfe <weswolf@aol.com> | 2012-10-17 04:56:11 -0500 |
commit | 6c2c2c19a24d98c1216cba9b9ded7a04fcb31654 (patch) | |
tree | afbeba71af056fcbbefdfa7f49135e6898f92941 /src/main | |
parent | 9fd9767a4a55c90bf488e2077123be8a55aaa982 (diff) | |
download | bukkit-6c2c2c19a24d98c1216cba9b9ded7a04fcb31654.tar bukkit-6c2c2c19a24d98c1216cba9b9ded7a04fcb31654.tar.gz bukkit-6c2c2c19a24d98c1216cba9b9ded7a04fcb31654.tar.lz bukkit-6c2c2c19a24d98c1216cba9b9ded7a04fcb31654.tar.xz bukkit-6c2c2c19a24d98c1216cba9b9ded7a04fcb31654.zip |
Add a tab completion API for chat messages. Adds BUKKIT-2607
This implementation provides access to a (mutable) list and the base
message. Also provided is a convenience method for getting the last
'token' in the provided string.
Diffstat (limited to 'src/main')
-rw-r--r-- | src/main/java/org/bukkit/event/player/PlayerChatTabCompleteEvent.java | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/src/main/java/org/bukkit/event/player/PlayerChatTabCompleteEvent.java b/src/main/java/org/bukkit/event/player/PlayerChatTabCompleteEvent.java new file mode 100644 index 00000000..761f7b11 --- /dev/null +++ b/src/main/java/org/bukkit/event/player/PlayerChatTabCompleteEvent.java @@ -0,0 +1,68 @@ +package org.bukkit.event.player; + +import java.util.Collection; + +import org.apache.commons.lang.Validate; +import org.bukkit.entity.Player; +import org.bukkit.event.HandlerList; + +/** + * Called when a player attempts to tab-complete a chat message. + */ +public class PlayerChatTabCompleteEvent extends PlayerEvent { + private static final HandlerList handlers = new HandlerList(); + private final String message; + private final String lastToken; + private final Collection<String> completions; + + public PlayerChatTabCompleteEvent(final Player who, final String message, final Collection<String> completions) { + super(who); + Validate.notNull(message, "Message cannot be null"); + Validate.notNull(completions, "Completions cannot be null"); + this.message = message; + int i = message.lastIndexOf(' '); + if (i < 0) { + this.lastToken = message; + } else { + this.lastToken = message.substring(i + 1); + } + this.completions = completions; + } + + /** + * Gets the chat message being tab-completed. + * + * @return the chat message + */ + public String getChatMessage() { + return message; + } + + /** + * Gets the last 'token' of the message being tab-completed. + * The token is the substring starting with the character after the last space in the message. + * + * @return The last token for the chat message + */ + public String getLastToken() { + return lastToken; + } + + /** + * This is the collection of completions for this event. + * + * @return the current completions + */ + public Collection<String> getTabCompletions() { + return completions; + } + + @Override + public HandlerList getHandlers() { + return handlers; + } + + public static HandlerList getHandlerList() { + return handlers; + } +} |