add comments in regional activity modules

xGinko · Jan 4, 2025 · 28cd893 · 28cd893
1 parent 2626cdc
commit 28cd893
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 6 deletions.
diff --git a/...in/java/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalActivityModule.java b/...in/java/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalActivityModule.java
@@ -48,7 +48,10 @@ public RegionalActivityModule(
         super("lag-preventions.regional-activity."+subConfigPath, defEnabled, comment);
         String configPath = "lag-preventions.regional-activity." + subConfigPath;
         this.logIsEnabled = config.getBoolean(configPath + ".log", deflogEnabled);
-        this.totalActivityLimit = config.getInt(configPath + ".total-limit", defTotalLimit);
+        this.totalActivityLimit = config.getInt(configPath + ".total-limit", defTotalLimit,
+                "The maximum amount of measured activity of this type that is allowed\n" +
+                        "to happen within the configured timeframe (cache-millis).\n" +
+                        "This value should always be higher than any of the configured per type limits.");
         this.checkRadius = config.getDouble(configPath + ".check-radius-blocks", defCheckRadius,
                 "The radius in blocks in which activity will be grouped together and measured.");
         this.pauseTimeMillis = config.getInt(configPath + ".pause-time-millis", defPauseMillis,

diff --git a/...va/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalBlockActivityModule.java b/...va/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalBlockActivityModule.java
@@ -39,7 +39,9 @@ public RegionalBlockActivityModule(
                 defaultKV.put(entry.getKey().get().name(), entry.getValue());
             }
         }
-        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV);
+        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV, """
+                Set activity limits per Material (BlockType).
+                Note that you cannot set a value higher than the one configured in total-limit.""");
         for (String configuredMaterial : typedSection.getKeys(false)) {
             try {
                 typedActivityLimit.put(Material.valueOf(configuredMaterial), Integer.parseInt(typedSection.getString(configuredMaterial)));

diff --git a/...a/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalEntityActivityModule.java b/...a/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalEntityActivityModule.java
@@ -39,7 +39,9 @@ public RegionalEntityActivityModule(
                 defaultKV.put(entry.getKey().get().name(), entry.getValue());
             }
         }
-        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV);
+        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV, """
+                Set activity limits per EntityType.
+                Note that you cannot set a value higher than the one configured in total-limit.""");
         for (String configuredEntity : typedSection.getKeys(false)) {
             try {
                 typedActivityLimit.put(EntityType.valueOf(configuredEntity), Integer.parseInt(typedSection.getString(configuredEntity)));

diff --git a/...in/java/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalActivityModule.java b/...in/java/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalActivityModule.java
@@ -48,7 +48,10 @@ public RegionalActivityModule(
         super("lag-preventions.regional-activity."+subConfigPath, defEnabled, comment);
         String configPath = "lag-preventions.regional-activity." + subConfigPath;
         this.logIsEnabled = config.getBoolean(configPath + ".log", deflogEnabled);
-        this.totalActivityLimit = config.getInt(configPath + ".total-limit", defTotalLimit);
+        this.totalActivityLimit = config.getInt(configPath + ".total-limit", defTotalLimit,
+                "The maximum amount of measured activity of this type that is allowed\n" +
+                        "to happen within the configured timeframe (cache-millis).\n" +
+                        "This value should always be higher than any of the configured per type limits.");
         this.checkRadius = config.getDouble(configPath + ".check-radius-blocks", defCheckRadius,
                 "The radius in blocks in which activity will be grouped together and measured.");
         this.pauseTimeMillis = config.getInt(configPath + ".pause-time-millis", defPauseMillis,

diff --git a/...va/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalBlockActivityModule.java b/...va/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalBlockActivityModule.java
@@ -39,7 +39,9 @@ public RegionalBlockActivityModule(
                 defaultKV.put(entry.getKey().get().name(), entry.getValue());
             }
         }
-        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV);
+        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV,
+                "Set activity limits per Material (BlockType)." +
+                "Note that you cannot set a value higher than the one configured in total-limit.");
         for (String configuredMaterial : typedSection.getKeys(false)) {
             try {
                 typedActivityLimit.put(Material.valueOf(configuredMaterial), Integer.parseInt(typedSection.getString(configuredMaterial)));

diff --git a/...a/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalEntityActivityModule.java b/...a/me/xginko/aef/modules/lagpreventions/regionalactivity/RegionalEntityActivityModule.java
@@ -39,7 +39,9 @@ public RegionalEntityActivityModule(
                 defaultKV.put(entry.getKey().get().name(), entry.getValue());
             }
         }
-        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV);
+        ConfigSection typedSection = config.getConfigSection(configPath + ".typed-limits", defaultKV,
+                "Set activity limits per EntityType." +
+                "Note that you cannot set a value higher than the one configured in total-limit.");
         for (String configuredEntity : typedSection.getKeys(false)) {
             try {
                 typedActivityLimit.put(EntityType.valueOf(configuredEntity), Integer.parseInt(typedSection.getString(configuredEntity)));