Skip to content

Commit cda45a1

Browse files
committed
Make note of noPermMsg change
This might actually be a bug, but until it's removed or fixed this note is still valid.
1 parent c26c935 commit cda45a1

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/main/java/com/laytonsmith/core/functions/Commands.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,8 @@ public String docs() {
313313
+ " or updates an existing one. Options is an associative array that can have the following keys:"
314314
+ " description, usage, permission, noPermMsg, aliases, tabcompleter, and/or executor. ---- "
315315
+ " The 'noPermMsg' argument is the message displayed when the user doesn't have the permission"
316-
+ " specified in 'permission'. The 'usage' is the message shown when the 'executor' returns false."
316+
+ " specified in 'permission' (unused as of Spigot 1.19)."
317+
+ " The 'usage' is the message shown when the 'executor' returns false."
317318
+ " The 'executor' is the closure run when the command is executed,"
318319
+ " and can return true or false (by default is treated as true). The 'tabcompleter' is the closure"
319320
+ " run when a user hits tab while the command is entered and ready for args."
@@ -341,7 +342,6 @@ public ExampleScript[] examples() throws ConfigCompileException {
341342
+ "\t'description': 'Spread the love!',\n"
342343
+ "\t'usage': '/hug <player>',\n"
343344
+ "\t'permission': 'perms.hugs',\n"
344-
+ "\t'noPermMsg': 'You do not have permission to give hugs to players (Sorry :o).',\n"
345345
+ "\t'tabcompleter':\n"
346346
+ "\t\tclosure(@alias, @sender, @args) {\n"
347347
+ "\t\t\t// This replicates the default tabcompleter for registered commands.\n"

src/main/resources/docs/Advanced_Guide

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ Commands may have additional annotations, which correspond to the values in regi
395395
@usage - Overrides the default usage example
396396
@permission - The permission the user must have to run this command. Note that this permission is in *addition* to the
397397
normal alias permission system, and so it's recommended to continue using the * label on the alias itself.
398-
@noPermMsg - Overrides the no permission error message
398+
@noPermMsg - Overrides the no permission error message (unused as of Spigot 1.19)
399399
@alias - Alias for this command. A command can have multiple aliases, and you can repeat this annotation to provide
400400
more.
401401

0 commit comments

Comments
 (0)