GH-202 V2.0/config refactor (#202)

vLuckyyy · CitralFlo · Jakubk15 · web-flow · commit a6984e269448 · 2025-02-08T22:26:57.000+01:00
* Refactor config description.

* fix.

* Update eternalcombat-plugin/src/main/java/com/eternalcode/combat/config/implementation/PluginConfig.java

Co-authored-by: Jakub Kędziora &lt;77227023+Jakubk15@users.noreply.github.com&gt;

* Follow review feedback.

* Refactor default messages.

* Remove gradient from combatNotification.

* Improve some messages.

* Add ASCII tag of EternalCombat in config

---------

Co-authored-by: Michał Wojtas &lt;80779749+CitralFlo@users.noreply.github.com&gt;
Co-authored-by: Jakub Kędziora &lt;77227023+Jakubk15@users.noreply.github.com&gt;
Co-authored-by: CitralFlo &lt;wojtas.michal90@gmail.com&gt;
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/bridge/BridgeService.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/bridge/BridgeService.java
@@ -32,7 +32,7 @@ public void init(FightManager fightManager, Server server) {
         this.initialize("WorldGuard",
             () -> this.regionProvider = new WorldGuardRegionProvider(this.pluginConfig.settings.blockedRegions, this.pluginConfig),
             () -> {
-                this.regionProvider = new DefaultRegionProvider(this.pluginConfig.settings.blockedRegionRadius);
+                this.regionProvider = new DefaultRegionProvider(this.pluginConfig.settings.restrictedRegionRadius);
 
                 this.logger.warning("WorldGuard is not installed, set to default region provider.");
             });
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/config/implementation/PluginConfig.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/config/implementation/PluginConfig.java
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/FightTagCommand.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/FightTagCommand.java
@@ -53,7 +53,7 @@ void status(@Context CommandSender sender, @Arg Player target) {
     @Priority(PriorityValue.HIGH)
     void tag(@Context CommandSender sender, @Arg Player target) {
         UUID targetUniqueId = target.getUniqueId();
-        Duration time = this.config.settings.combatDuration;
+        Duration time = this.config.settings.combatTimerDuration;
 
         FightTagEvent event = this.fightManager.tag(targetUniqueId, time, CauseOfTag.COMMAND);
 
@@ -76,7 +76,7 @@ void tag(@Context CommandSender sender, @Arg Player target) {
     @Execute(name = "tag")
     @Permission("eternalcombat.tag")
     void tagMultiple(@Context CommandSender sender, @Arg Player firstTarget, @Arg Player secondTarget) {
-        Duration combatTime = this.config.settings.combatDuration;
+        Duration combatTime = this.config.settings.combatTimerDuration;
         PluginConfig.Messages messages = this.config.messages;
 
         if (sender.equals(firstTarget) || sender.equals(secondTarget)) {
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightActionBlockerController.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightActionBlockerController.java
@@ -33,7 +33,7 @@ public FightActionBlockerController(FightManager fightManager, NotificationAnnou
 
     @EventHandler
     void onPlace(BlockPlaceEvent event) {
-        if (!this.config.settings.shouldPreventBlockPlacing) {
+        if (!this.config.settings.disableBlockPlacing) {
             return;
         }
 
@@ -47,7 +47,7 @@ void onPlace(BlockPlaceEvent event) {
         Block block = event.getBlock();
         int level = block.getY();
 
-        List<Material> specificBlocksToPreventPlacing = this.config.settings.specificBlocksToPreventPlacing;
+        List<Material> specificBlocksToPreventPlacing = this.config.settings.restrictedBlockTypes;
 
         boolean isPlacementBlocked = this.isPlacementBlocked(level);
 
@@ -56,8 +56,8 @@ void onPlace(BlockPlaceEvent event) {
             this.announcer.create()
                 .player(uniqueId)
                 .notice(this.config.messages.blockPlacingBlockedDuringCombat)
-                .placeholder("{Y}", String.valueOf(this.config.settings.blockPlacingYCoordinate))
-                .placeholder("{MODE}", this.config.settings.blockPlacingModeName)
+                .placeholder("{Y}", String.valueOf(this.config.settings.blockPlacementYCoordinate))
+                .placeholder("{MODE}", this.config.settings.blockPlacementModeDisplayName)
                 .send();
 
         }
@@ -70,22 +70,22 @@ void onPlace(BlockPlaceEvent event) {
             this.announcer.create()
                 .player(uniqueId)
                 .notice(this.config.messages.blockPlacingBlockedDuringCombat)
-                .placeholder("{Y}", String.valueOf(this.config.settings.blockPlacingYCoordinate))
-                .placeholder("{MODE}", this.config.settings.blockPlacingModeName)
+                .placeholder("{Y}", String.valueOf(this.config.settings.blockPlacementYCoordinate))
+                .placeholder("{MODE}", this.config.settings.blockPlacementModeDisplayName)
                 .send();
 
         }
     }
 
     private boolean isPlacementBlocked(int level) {
-        return this.config.settings.blockPlacingMode == PluginConfig.Settings.BlockPlacingMode.ABOVE
-            ? level > this.config.settings.blockPlacingYCoordinate
-            : level < this.config.settings.blockPlacingYCoordinate;
+        return this.config.settings.blockPlacementMode == PluginConfig.Settings.BlockPlacingMode.ABOVE
+            ? level > this.config.settings.blockPlacementYCoordinate
+            : level < this.config.settings.blockPlacementYCoordinate;
     }
 
     @EventHandler
     void onToggleGlide(EntityToggleGlideEvent event) {
-        if (!this.config.settings.shouldPreventElytraUsage) {
+        if (!this.config.settings.disableElytraUsage) {
             return;
         }
 
@@ -105,7 +105,7 @@ void onToggleGlide(EntityToggleGlideEvent event) {
 
     @EventHandler
     void onFly(PlayerToggleFlightEvent event) {
-        if (!this.config.settings.shouldPreventFlying) {
+        if (!this.config.settings.disableFlying) {
             return;
         }
 
@@ -125,7 +125,7 @@ void onFly(PlayerToggleFlightEvent event) {
 
     @EventHandler
     void onDamage(EntityDamageEvent event) {
-        if (!this.config.settings.shouldElytraDisableOnDamage) {
+        if (!this.config.settings.disableElytraOnDamage) {
             return;
         }
 
@@ -141,7 +141,7 @@ void onDamage(EntityDamageEvent event) {
 
     @EventHandler
     void onOpenInventory(InventoryOpenEvent event) {
-        if (!this.config.settings.shouldPreventInventoryOpening) {
+        if (!this.config.settings.disableInventoryAccess) {
             return;
         }
 
@@ -172,10 +172,10 @@ void onPlayerCommandPreprocess(PlayerCommandPreprocessEvent event) {
 
         String command = event.getMessage().split(" ")[0].substring(1).toLowerCase();
 
-        boolean isMatchCommand = this.config.settings.blockedCommands.stream()
+        boolean isMatchCommand = this.config.settings.restrictedCommands.stream()
             .anyMatch(command::startsWith);
 
-        WhitelistBlacklistMode mode = this.config.settings.commandBlockingMode;
+        WhitelistBlacklistMode mode = this.config.settings.commandRestrictionMode;
 
         boolean shouldCancel = mode.shouldBlock(isMatchCommand);
 
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightTagController.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightTagController.java
@@ -35,7 +35,7 @@ void onEntityDamageByEntity(EntityDamageByEntityEvent event) {
             return;
         }
 
-        List<EntityType> disabledProjectileEntities = this.config.settings.disabledProjectileEntities;
+        List<EntityType> disabledProjectileEntities = this.config.settings.ignoredProjectileTypes;
 
         if (event.getDamager() instanceof Projectile projectile && disabledProjectileEntities.contains(projectile.getType())) {
             return;
@@ -51,7 +51,7 @@ void onEntityDamageByEntity(EntityDamageByEntityEvent event) {
             return;
         }
 
-        Duration combatTime = this.config.settings.combatDuration;
+        Duration combatTime = this.config.settings.combatTimerDuration;
         UUID attackedUniqueId = attackedPlayerByPerson.getUniqueId();
         UUID attackerUniqueId = attacker.getUniqueId();
 
@@ -63,7 +63,7 @@ void onEntityDamageByEntity(EntityDamageByEntityEvent event) {
             return;
         }
 
-        if (this.config.settings.shouldPreventFlying) {
+        if (this.config.settings.disableFlying) {
             if (attackedPlayerByPerson.isFlying()) {
                 attackedPlayerByPerson.setFlying(false);
                 attackedPlayerByPerson.setAllowFlight(false);
@@ -81,7 +81,7 @@ void onEntityDamageByEntity(EntityDamageByEntityEvent event) {
 
     @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
     void onEntityDamage(EntityDamageEvent event) {
-        if (!this.config.settings.shouldEnableDamageCauses) {
+        if (!this.config.settings.enableDamageCauseLogging) {
             return;
         }
 
@@ -97,12 +97,12 @@ void onEntityDamage(EntityDamageEvent event) {
             return;
         }
 
-        Duration combatTime = this.config.settings.combatDuration;
+        Duration combatTime = this.config.settings.combatTimerDuration;
 
         UUID uuid = player.getUniqueId();
 
-        List<EntityDamageEvent.DamageCause> damageCauses = this.config.settings.damageCausesToLog;
-        WhitelistBlacklistMode mode = this.config.settings.damageCausesMode;
+        List<EntityDamageEvent.DamageCause> damageCauses = this.config.settings.loggedDamageCauses;
+        WhitelistBlacklistMode mode = this.config.settings.damageCauseRestrictionMode;
 
         EntityDamageEvent.DamageCause cause = event.getCause();
 
@@ -131,15 +131,15 @@ Player getDamager(EntityDamageByEntityEvent event) {
     private boolean isPlayerInDisabledWorld(Player player) {
         String worldName = player.getWorld().getName();
 
-        return this.config.settings.worldsToIgnore.contains(worldName);
+        return this.config.settings.ignoredWorlds.contains(worldName);
     }
 
     private boolean cannotBeTagged(Player player) {
-        if (player.getGameMode().equals(GameMode.CREATIVE) && this.config.settings.excludeCreativeFromCombat) {
+        if (player.getGameMode().equals(GameMode.CREATIVE) && this.config.settings.excludeCreativePlayersFromCombat) {
             return true;
         }
 
-        if (player.isOp() && this.config.settings.excludeOpFromCombat) {
+        if (player.isOp() && this.config.settings.excludeAdminsFromCombat) {
             return true;
         }
 
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightUnTagController.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/controller/FightUnTagController.java
@@ -34,7 +34,7 @@ void onPlayerDeath(PlayerDeathEvent event) {
 
         this.fightManager.untag(player.getUniqueId(), cause);
 
-        if (killer != null && this.config.settings.shouldReleaseAttacker) {
+        if (killer != null && this.config.settings.releaseAttackerOnVictimDeath) {
             this.fightManager.untag(killer.getUniqueId(), CauseOfUnTag.ATTACKER_RELEASE);
         }
     }
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/region/RegionController.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/region/RegionController.java
@@ -56,9 +56,9 @@ void onPlayerMove(PlayerMoveEvent event) {
 
             Vector knockbackVector = new Vector(subtract.getX(), 0, subtract.getZ()).normalize();
             Vector configuredVector = new Vector(
-                this.pluginConfig.settings.blockedRegionKnockMultiplier,
+                this.pluginConfig.settings.regionKnockbackMultiplier,
                 0.5,
-                this.pluginConfig.settings.blockedRegionKnockMultiplier);
+                this.pluginConfig.settings.regionKnockbackMultiplier);
 
             player.setVelocity(knockbackVector.multiply(configuredVector));
 
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/region/WorldGuardRegionProvider.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/region/WorldGuardRegionProvider.java
@@ -48,7 +48,7 @@ private boolean isCombatRegion(ProtectedRegion region) {
             return true;
         }
 
-        if (this.pluginConfig.settings.shouldPreventPvpRegions) {
+        if (this.pluginConfig.settings.preventPvpInRegions) {
             StateFlag.State flag = region.getFlag(Flags.PVP);
 
             if (flag != null) {
diff --git a/eternalcombat-plugin/src/main/java/com/eternalcode/combat/updater/UpdaterNotificationController.java b/eternalcombat-plugin/src/main/java/com/eternalcode/combat/updater/UpdaterNotificationController.java
@@ -33,7 +33,7 @@ void onJoin(PlayerJoinEvent event) {
         Player player = event.getPlayer();
         Audience audience = this.audienceProvider.player(player.getUniqueId());
 
-        if (!player.hasPermission(RECEIVE_UPDATES_PERMISSION) || !this.pluginConfig.settings.shouldReceivePluginUpdates) {
+        if (!player.hasPermission(RECEIVE_UPDATES_PERMISSION) || !this.pluginConfig.settings.notifyAboutUpdates) {
             return;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ void onPlayerDeath(PlayerDeathEvent event) {`
`34`	`34`
`35`	`35`	`this.fightManager.untag(player.getUniqueId(), cause);`
`36`	`36`
`37`		`- if (killer != null && this.config.settings.shouldReleaseAttacker) {`
	`37`	`+ if (killer != null && this.config.settings.releaseAttackerOnVictimDeath) {`
`38`	`38`	`this.fightManager.untag(killer.getUniqueId(), CauseOfUnTag.ATTACKER_RELEASE);`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ private boolean isCombatRegion(ProtectedRegion region) {`
`48`	`48`	`return true;`
`49`	`49`	`}`
`50`	`50`
`51`		`- if (this.pluginConfig.settings.shouldPreventPvpRegions) {`
	`51`	`+ if (this.pluginConfig.settings.preventPvpInRegions) {`
`52`	`52`	`StateFlag.State flag = region.getFlag(Flags.PVP);`
`53`	`53`
`54`	`54`	`if (flag != null) {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ void onJoin(PlayerJoinEvent event) {`
`33`	`33`	`Player player = event.getPlayer();`
`34`	`34`	`Audience audience = this.audienceProvider.player(player.getUniqueId());`
`35`	`35`
`36`		`- if (!player.hasPermission(RECEIVE_UPDATES_PERMISSION) \|\| !this.pluginConfig.settings.shouldReceivePluginUpdates) {`
	`36`	`+ if (!player.hasPermission(RECEIVE_UPDATES_PERMISSION) \|\| !this.pluginConfig.settings.notifyAboutUpdates) {`
`37`	`37`	`return;`
`38`	`38`	`}`
`39`	`39`