General clarification of the config

Certain values were rather vague and caused some confusion in the past, hopefully things are more clear now.
This commit is contained in:
NotMyFault 2019-10-01 14:01:50 +02:00
parent ca25b7b3c8
commit 59bc6f19e5

View File

@ -256,10 +256,10 @@ public class Settings extends Config {
public static final class Done {
@Comment("Require a done plot to download") public static boolean REQUIRED_FOR_DOWNLOAD =
@Comment("Require a plot marked as done to download") public static boolean REQUIRED_FOR_DOWNLOAD =
false;
@Comment("Only done plots can be rated") public static boolean REQUIRED_FOR_RATINGS = false;
@Comment("Restrict building when a plot is done") public static boolean RESTRICT_BUILDING =
@Comment("Only plots marked as done can be rated") public static boolean REQUIRED_FOR_RATINGS = false;
@Comment("Restrict building when a plot is marked as done") public static boolean RESTRICT_BUILDING =
false;
@Comment("The limit being how many plots a player can claim") public static boolean
COUNTS_TOWARDS_LIMIT = true;
@ -269,14 +269,15 @@ public class Settings extends Config {
public static final class Chat {
@Comment("Sometimes console color doesn't work, you can disable it here")
public static boolean CONSOLE_COLOR = true;
@Comment("Should chat be interactive") public static boolean INTERACTIVE = true;
@Comment("Should the chat be interactive?") public static boolean INTERACTIVE = true;
}
@Comment("Relating to how many plots someone can claim ") public static final class Limit {
@Comment("Should the limit be global (over multiple worlds)") public static boolean GLOBAL =
false;
@Comment("The range of permissions to check e.g. plots.plot.127") public static int
@Comment({"The max. range of permissions to check e.g. plots.plot.127", "The value covers the range to check only, you need to assign the permission to players/groups still",
"Modifying the value does NOT change the amount of plots players can claim"}) public static int
MAX_PLOTS = 127;
}
@ -291,7 +292,7 @@ public class Settings extends Config {
@Comment("Teleport to your plot on death") public static boolean ON_DEATH = false;
@Comment("Teleport to your plot on login") public static boolean ON_LOGIN = false;
@Comment("Teleport to your plot on claim") public static boolean ON_CLAIM = true;
@Comment("Add a teleportation delay to all commands") public static int DELAY = 0;
@Comment("Add a delay to all teleport commands") public static int DELAY = 0;
@Comment("The visit command is ordered by world instead of globally") public static boolean
PER_WORLD_VISIT = false;
}
@ -322,7 +323,7 @@ public class Settings extends Config {
@Comment(
{"Enable or disable part of the plugin", "Note: A cache will use some memory if enabled"})
{"Enable or disable parts of the plugin", "Note: A cache will use some memory if enabled"})
public static final class Enabled_Components { // Group the following values into a new config section
@Comment("The database stores all the plots") public static boolean DATABASE = true;
@Comment("Events are needed to track a lot of things") public static boolean EVENTS = true;
@ -339,7 +340,7 @@ public class Settings extends Config {
@Comment("Allow WorldEdit to be restricted to plots") public static boolean
WORLDEDIT_RESTRICTIONS = true;
@Comment("Allow economy to be used") public static boolean ECONOMY = true;
@Comment("Send anonymous usage statistics. Bukkit only setting.") public static boolean
@Comment("Send anonymous usage statistics to bStats. Bukkit only setting.") public static boolean
METRICS = true;
@Comment("Expiry will clear old or simplistic plots") public static boolean PLOT_EXPIRY =
false;
@ -355,7 +356,7 @@ public class Settings extends Config {
@Comment("Actively purge invalid database entries") public static boolean DATABASE_PURGER =
false;
@Comment("Delete plots when a player is banned") public static boolean BAN_DELETER = false;
@Comment("Prevent possibly unsafe blocks from being used in plot components")
@Comment({"Prevent possibly unsafe blocks from being used in plot components", "Can be bypassed with `/plot debugallowunsafe`"})
public static boolean PREVENT_UNSAFE = true;
}
}