summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormd_5 <git@md-5.net>2018-11-15 11:07:00 +1100
committermd_5 <git@md-5.net>2018-11-15 11:07:00 +1100
commit7631ed33d4c4144127be13dc6796b420cea2c636 (patch)
tree1fcbddb9a3491dafff2630ef32dd97d1423cacec
parent0828ce3661af80456dc28fc7f2637c687a488988 (diff)
downloadbukkit-7631ed33d4c4144127be13dc6796b420cea2c636.tar
bukkit-7631ed33d4c4144127be13dc6796b420cea2c636.tar.gz
bukkit-7631ed33d4c4144127be13dc6796b420cea2c636.tar.lz
bukkit-7631ed33d4c4144127be13dc6796b420cea2c636.tar.xz
bukkit-7631ed33d4c4144127be13dc6796b420cea2c636.zip
Clarify what "return false" in onCommand does.
-rw-r--r--src/main/java/org/bukkit/command/CommandExecutor.java5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/main/java/org/bukkit/command/CommandExecutor.java b/src/main/java/org/bukkit/command/CommandExecutor.java
index c75586f7..ae31ff8a 100644
--- a/src/main/java/org/bukkit/command/CommandExecutor.java
+++ b/src/main/java/org/bukkit/command/CommandExecutor.java
@@ -6,7 +6,10 @@ package org.bukkit.command;
public interface CommandExecutor {
/**
- * Executes the given command, returning its success
+ * Executes the given command, returning its success.
+ * <br>
+ * If false is returned, then the "usage" plugin.yml entry for this command
+ * (if defined) will be sent to the player.
*
* @param sender Source of the command
* @param command Command which was executed