Permalink
Browse files

Document likely scoreboard string length limits

  • Loading branch information...
PseudoKnight committed Aug 14, 2018
1 parent f8bf56c commit 73a1ee7b7c6e75643836b5b0938986bed5d3202c
Showing with 6 additions and 0 deletions.
  1. +6 −0 src/main/java/com/laytonsmith/core/functions/Scoreboards.java
@@ -676,6 +676,8 @@ public String docs() {
+ " with keys 'displayname' and/or 'slot', affecting their respective properties."
+ " Null name resets it to the actual name, and null slot removes it from"
+ " all displays. Slot can be one of: " + StringUtils.Join(MCDisplaySlot.values(), ", ", ", or ")
+ " If the displayname is too long, a LengthException will be thrown."
+ " The max length may differ based on server implementation, but will probably be 128."
+ ". " + DEF_MSG;
}
@@ -765,6 +767,9 @@ public String docs() {
+ " If arg 2 is not an array, it is assumed to be the displayname,"
+ " otherwise arg 2 should be an array with keys 'displayname', 'prefix',"
+ " and/or 'suffix', affecting their respective properties."
+ " If the prefix, suffix, or displayname is too long, a LengthException will be thrown."
+ " The max length may differ based on server implementation,"
+ " but will probably be 64, 64, 128 respectively."
+ " Null name resets it to the actual name, and null prefix or suffix removes it from"
+ " all displays. " + DEF_MSG;
}
@@ -1094,6 +1099,7 @@ public String getName() {
public String docs() {
return "void {objectiveName, name, int, [scoreboard]} Sets the player's score for the given objective."
+ " The name can be anything, not just player names. An LengthException is thrown if it's too long."
+ " The max length may differ based on server implementation, but will probably be 128."
+ DEF_MSG;
}

0 comments on commit 73a1ee7

Please sign in to comment.