Skip to content

Commit

Permalink
Some suggestions by Inscrutable
Browse files Browse the repository at this point in the history
true/false > enabled/disabled
'asynchronously'
  • Loading branch information
phit committed Feb 16, 2018
1 parent 43f9f79 commit 5a43cbe
Show file tree
Hide file tree
Showing 20 changed files with 33 additions and 33 deletions.
Expand Up @@ -30,10 +30,10 @@
@ConfigSerializable
public class AsyncLightingCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If enabled, runs lighting updates asynchronous.")
@Setting(value = "enabled", comment = "If 'true', runs lighting updates asynchronously.")
private boolean enabled = true;

@Setting(value = "num-threads", comment = "The amount of threads to dedicate for async lighting updates. (Default: 2)")
@Setting(value = "num-threads", comment = "The amount of threads to dedicate for asynchronous lighting updates. (Default: 2)")
private int numAsyncThreads = 2;

public boolean isEnabled() {
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class BlockCapturingCategory extends ConfigCategory {

@Setting(value = "auto-populate", comment = "If enabled, newly discovered blocks will be added to this config with a default value.")
@Setting(value = "auto-populate", comment = "If 'true', newly discovered blocks will be added to this config with a default value.")
private boolean autoPopulate = false;

@Setting(value = "mods", comment = "Per-mod block id mappings for controlling capturing behavior")
Expand Down
Expand Up @@ -33,9 +33,9 @@
@ConfigSerializable
public class BlockCapturingModCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If disabled, all specific rules for this mod will be ignored.")
@Setting(value = "enabled", comment = "If 'false', all specific rules for this mod will be ignored.")
private boolean isEnabled = true;
@Setting(value = "block-tick-capturing", comment = "If enabled, individual capturing (i.e. skip bulk capturing) for scheduled ticks for \n"
@Setting(value = "block-tick-capturing", comment = "If 'true', individual capturing (i.e. skip bulk capturing) for scheduled ticks for \n"
+ "a block type will be performed.")
private Map<String, Boolean> blockMap = new HashMap<>();

Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class BlockTrackingCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If enabled, adds player tracking support for block positions. \n"
@Setting(value = "enabled", comment = "If 'true', adds player tracking support for block positions. \n"
+ "Note: This should only be disabled if you do not care who caused a block to change.")
private boolean enabled = true;

Expand Down
Expand Up @@ -30,7 +30,7 @@
@ConfigSerializable
public class BungeeCordCategory extends ConfigCategory {

@Setting(value = "ip-forwarding", comment = "If enabled, allows BungeeCord to forward IP address, UUID, and Game Profile to this server.")
@Setting(value = "ip-forwarding", comment = "If 'true', allows BungeeCord to forward IP address, UUID, and Game Profile to this server.")
private boolean ipForwarding = false;

public boolean getIpForwarding() {
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class CollisionModCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If disabled, entity collision rules for this mod will be ignored.")
@Setting(value = "enabled", comment = "If 'false', entity collision rules for this mod will be ignored.")
private boolean isEnabled = true;
@Setting(value = "defaults", comment = "Default maximum collisions used for all entities/blocks unless overridden.")
private Map<String, Integer> defaultMaxCollisions = new HashMap<>();
Expand Down
Expand Up @@ -30,7 +30,7 @@
@ConfigSerializable
public class DebugCategory extends ConfigCategory {

@Setting(value = "thread-contention-monitoring", comment = "Enable Java's thread contention monitoring for thread dumps")
@Setting(value = "thread-contention-monitoring", comment = "Set to 'true' to enable Java's thread contention monitoring for thread dumps.")
private boolean enableThreadContentionMonitoring = false;
@Setting(value = "dump-chunks-on-deadlock", comment = "Dump chunks in the event of a deadlock")
private boolean dumpChunksOnDeadlock = false;
Expand All @@ -40,8 +40,8 @@ public class DebugCategory extends ConfigCategory {
private boolean dumpThreadsOnWarn = false;

@Setting(value = "concurrent-entity-checks", comment = "Detect and prevent certain attempts to use entities concurrently. \n"
+ "WARNING: May drastically decrease server performance. Only enable this to debug a "
+ "pre-existing issue.")
+ "WARNING: May drastically decrease server performance. Only set this to 'true' "
+ "to debug a pre-existing issue.")
private boolean concurrentChecks = false;

public boolean doConcurrentChecks() {
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class EntityActivationModCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If disabled, entity activation rules for this mod will be ignored and always tick.")
@Setting(value = "enabled", comment = "If 'false', entity activation rules for this mod will be ignored and always tick.")
private boolean isEnabled = true;
@Setting(value = "defaults")
private Map<String, Integer> defaultRanges = new HashMap<>();
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class EntityActivationRangeCategory extends ConfigCategory {

@Setting(value = "auto-populate", comment = "If enabled, newly discovered entities will be added to this config with a default value.")
@Setting(value = "auto-populate", comment = "If 'true', newly discovered entities will be added to this config with a default value.")
private boolean autoPopulate = false;
@Setting(value = "defaults", comment = "Default activation ranges used for all entities unless overridden.")
private Map<String, Integer> defaultRanges = new HashMap<>();
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class EntityCollisionCategory extends ConfigCategory {

@Setting(value = "auto-populate", comment = "If enabled, newly discovered entities/blocks will be added to this config with a default value.")
@Setting(value = "auto-populate", comment = "If 'true', newly discovered entities/blocks will be added to this config with a default value.")
private boolean autoPopulate = false;
@Setting(value = "max-entities-within-aabb", comment = "Maximum amount of entities any given entity or block can collide with. This improves \n"
+ "performance when there are more than 8 entities on top of each other such as a 1x1 \n"
Expand Down
Expand Up @@ -30,7 +30,7 @@
@ConfigSerializable
public class GlobalGeneralCategory extends GeneralCategory {

@Setting(value = "file-io-thread-sleep", comment = "Enabled sleeping between chunk saves, beware of memory issues.")
@Setting(value = "file-io-thread-sleep", comment = "Set to 'true' if sleeping between chunk saves will be enabled, beware of memory issues.")
private boolean fileIOThreadSleep = false;

public GlobalGeneralCategory() {
Expand Down
Expand Up @@ -38,7 +38,7 @@ public class GlobalWorldCategory extends WorldCategory {
+ "Note: 20 ticks is equivalent to 1 second. Set to 0 to disable.")
private int autoPlayerSaveInterval = 900;

@Setting(value = "leaf-decay", comment = "Enable to allow natural leaf decay.")
@Setting(value = "leaf-decay", comment = "Set to 'true' to allow natural leaf decay.")
private boolean leafDecay = true;

@Setting(value = "gameprofile-lookup-batch-size", comment = "The amount of GameProfile requests to make against Mojang's session server. (Default: 1) \n"
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class OptimizationCategory extends ConfigCategory {

private static final String PRE_MERGE_COMMENT = "If enabled, block item drops are pre-processed to avoid \n"
private static final String PRE_MERGE_COMMENT = "If 'true', block item drops are pre-processed to avoid \n"
+ "having to spawn extra entities that will be merged post spawning. \n"
+ "Usually, Sponge is smart enough to determine when to attempt an item pre-merge \n"
+ "and when not to, however, in certain cases, some mods rely on items not being \n"
Expand All @@ -54,10 +54,10 @@ public class OptimizationCategory extends ConfigCategory {
+ "Warning: disabling structure saving will break the vanilla locate command.")
private StructureSaveCategory structureSaveCategory = new StructureSaveCategory();

@Setting(value = "async-lighting", comment = "Runs lighting updates asynchronous.")
@Setting(value = "async-lighting", comment = "Runs lighting updates asynchronously.")
private AsyncLightingCategory asyncLightingCategory = new AsyncLightingCategory();

@Setting(value = "panda-redstone", comment = "If enabled, uses Panda4494's redstone implementation which improves performance. \n"
@Setting(value = "panda-redstone", comment = "If 'true', uses Panda4494's redstone implementation which improves performance. \n"
+ "See https://bugs.mojang.com/browse/MC-11193 for more information. \n"
+ "Note: This optimization has a few issues which are explained in the bug report.")
private boolean pandaRedstone = false;
Expand Down
Expand Up @@ -53,7 +53,7 @@ public class PhaseTrackerCategory extends ConfigCategory {
+ "and emit a warning about said spawn anyways.")
private boolean captureAndSpawnEntitiesSync = true;

@Setting(value = "generate-stacktrace-per-phase", comment = "If true, enables some more thorough debugging for PhaseStates \n"
@Setting(value = "generate-stacktrace-per-phase", comment = "Set to 'true' for some more thorough debugging for PhaseStates \n"
+ "such that a StackTrace is created every time a PhaseState \n"
+ "switches, allowing for more fine grained troubleshooting \n"
+ "in the cases of runaway phase states. Note that this is \n"
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class StructureModCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If disabled, this mod will never save its structures.")
@Setting(value = "enabled", comment = "If 'false', this mod will never save its structures.")
private boolean isEnabled = true;
@Setting(value = "structures")
private Map<String, Boolean> structureList = new HashMap<>();
Expand Down
Expand Up @@ -35,7 +35,7 @@ public class StructureSaveCategory extends ConfigCategory {

@Setting(value = "enabled")
private boolean isEnabled = false;
@Setting(value = "auto-populate", comment = "If enabled, newly discovered structures will be added to this config with a default value.")
@Setting(value = "auto-populate", comment = "If 'true', newly discovered structures will be added to this config with a default value.")
private boolean autoPopulate = false;
@Setting(value = "mods", comment = "Per-mod overrides. Refer to the minecraft default mod for example.")
private Map<String, StructureModCategory> modList = new HashMap<>();
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class TeleportHelperCategory extends ConfigCategory {

@Setting(value = "force-blacklist", comment = "If enabled, this blacklist will always be respected, otherwise, plugins can choose whether \n"
@Setting(value = "force-blacklist", comment = "If 'true', this blacklist will always be respected, otherwise, plugins can choose whether \n"
+ "or not to respect it.")
private boolean forceBlacklistOn = false;

Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class TileEntityActivationCategory extends ConfigCategory {

@Setting(value = "auto-populate", comment = "If enabled, newly discovered tileentities will be added to this config with default settings.")
@Setting(value = "auto-populate", comment = "If 'true', newly discovered tileentities will be added to this config with default settings.")
private boolean autoPopulate = false;
@Setting(value = "default-block-range", comment = "Default activation block range used for all tileentities unless overridden.")
private int defaultBlockRange = 64;
Expand Down
Expand Up @@ -33,7 +33,7 @@
@ConfigSerializable
public class TileEntityActivationModCategory extends ConfigCategory {

@Setting(value = "enabled", comment = "If disabled, tileentity activation rules for this mod will be ignored and always tick.")
@Setting(value = "enabled", comment = "If 'false', tileentity activation rules for this mod will be ignored and always tick.")
private boolean isEnabled = true;
@Setting(value = "default-block-range")
private Integer defaultBlockRange;
Expand Down
Expand Up @@ -50,27 +50,27 @@ public class WorldCategory extends ConfigCategory {
+ "This value is capped to the current view distance setting in server.properties")
protected int mobSpawnRange = 4;

@Setting(value = "world-enabled", comment = "Enable if this world should be registered.")
@Setting(value = "world-enabled", comment = "Set to 'true' if this world should be registered.")
protected boolean worldEnabled = true;

@Setting(value = "load-on-startup", comment = "Enable if this world should be loaded on startup.")
@Setting(value = "load-on-startup", comment = "Set to 'true' if this world should be loaded on startup.")
protected Boolean loadOnStartup;

@Setting(value = "generate-spawn-on-load", comment = "Enable if you want the world to generate spawn the moment its loaded.")
@Setting(value = "generate-spawn-on-load", comment = "Set to 'true' if you want the world to generate spawn the moment its loaded.")
protected Boolean generateSpawnOnLoad;

@Setting(value = "keep-spawn-loaded", comment = "Enable if this world's spawn should remain loaded with no players.")
@Setting(value = "keep-spawn-loaded", comment = "Set to 'true' if this world's spawn should remain loaded with no players.")
protected Boolean keepSpawnLoaded;

@Setting(value = "pvp-enabled", comment = "Enable if this world allows PVP combat.")
@Setting(value = "pvp-enabled", comment = "Set to 'true' to allow PVP combat in this world.")
protected boolean pvpEnabled = true;

@Setting(value = "portal-agents", comment = "A list of all detected portal agents used in this world. \n"
+ "In order to override, change the target world name to any other valid world. \n"
+ "Note: If world is not found, it will fallback to default.")
private Map<String, String> portalAgents = new HashMap<>();

@Setting(value = "deny-chunk-requests", comment = "If enabled, any request for a chunk not currently loaded will be denied (exceptions apply \n"
@Setting(value = "deny-chunk-requests", comment = "If 'true', any request for a chunk not currently loaded will be denied (exceptions apply \n"
+ "for things like world gen and player movement). \n"
+ "Note: As this is an experimental setting for performance gain, if you encounter any issues \n"
+ "then we recommend disabling it.")
Expand Down Expand Up @@ -105,10 +105,10 @@ public class WorldCategory extends ConfigCategory {
+ "areas for more items. Setting to a negative value is not supported!")
private double itemMergeRadius = 2.5D;

@Setting(value = "weather-thunder", comment = "Enable to initiate thunderstorms in supported biomes.")
@Setting(value = "weather-thunder", comment = "Set to 'true' to initiate thunderstorms in supported biomes.")
private boolean weatherThunder = true;

@Setting(value = "weather-ice-and-snow", comment = "Enable to allow the natural formation of ice and snow in supported biomes.")
@Setting(value = "weather-ice-and-snow", comment = "Set to 'true' to allow the natural formation of ice and snow in supported biomes.")
private boolean weatherIceAndSnow = true;

public static final int USE_SERVER_VIEW_DISTANCE = -1;
Expand Down

0 comments on commit 5a43cbe

Please sign in to comment.