Skip to content

Add restart message for config options that only applies after a server restart #3400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benwoo1110 merged 1 commit into from
Dec 10, 2025
Merged

Add restart message for config options that only applies after a server restart #3400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.vavr.control.Try;
import jakarta.inject.Inject;
import jakarta.inject.Provider;
import org.bukkit.ChatColor;
import org.bukkit.command.CommandSender;
import org.bukkit.event.EventPriority;
import org.bukkit.plugin.PluginManager;
Expand Down Expand Up @@ -139,17 +140,25 @@
.comment("Sets whether Multiverse will apply the world's entity `tick-rate` config in worlds.yml.")
.comment("If disabled, the `tick-rate` config in worlds.yml will be ignored.")
.comment("Disable this if you want paper-world.yml or another plugin to handle entity spawn rate per world.")
.comment("!!!NOTE: This will only apply after a server restart!")

Check failure on line 143 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Define a constant instead of duplicating this literal "!!!NOTE: This will only apply after a server restart!" 4 times. 


See more on https://sonarcloud.io/project/issues?id=Multiverse_Multiverse-Core&issues=AZsDKJ_cMI8WbQHPlFdz&open=AZsDKJ_cMI8WbQHPlFdz&pullRequest=3400
.defaultValue(true)
.name("apply-entity-spawn-rate")
.onChange(((sender, oldValue, newValue) ->

Check warning on line 146 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Unnecessary parentheses around assignment right-hand side.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:146:23: warning: Unnecessary parentheses around assignment right-hand side. (com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck)
sender.sendMessage(ChatColor.YELLOW + "'apply-entity-spawn-rate' config option will only take " +

Check warning on line 147 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
'+' should be on a new line.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:147:117: warning: '+' should be on a new line. (com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck)
"full effect after a server restart.")))
.build());

final ConfigNode<Boolean> applyEntitySpawnLimit = node(ConfigNode.builder("world.apply-entity-spawn-limit", Boolean.class)
.comment("")
.comment("Sets whether Multiverse will apply the world's entity `spawn-limit` config when a world is loaded.")
.comment("If disabled, the `spawn-limit` config in worlds.yml will be ignored.")
.comment("Disable this if you want paper-world.yml or another plugin to handle entity limits per world.")
.comment("!!!NOTE: This will only apply after a server restart!")
.defaultValue(true)
.name("apply-entity-spawn-limit")
.onChange(((sender, oldValue, newValue) ->

Check warning on line 159 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Unnecessary parentheses around assignment right-hand side.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:159:23: warning: Unnecessary parentheses around assignment right-hand side. (com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck)
sender.sendMessage(ChatColor.YELLOW + "'apply-entity-spawn-limit' config option will only take" +

Check warning on line 160 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
'+' should be on a new line.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:160:117: warning: '+' should be on a new line. (com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck)
" full effect after a server restart.")))
.build());

final ConfigNode<Boolean> autoPurgeEntities = node(ConfigNode.builder("world.auto-purge-entities", Boolean.class)
Expand Down Expand Up @@ -478,6 +487,9 @@
.name("event-priority-player-portal")
.onLoadAndChange((oldValue, newValue) ->
eventPriorityMapper.get().setPriority("mvcore-player-portal", newValue))
.onChange(((sender, oldValue, newValue) ->

Check warning on line 490 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Unnecessary parentheses around assignment right-hand side.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:490:23: warning: Unnecessary parentheses around assignment right-hand side. (com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck)
sender.sendMessage(ChatColor.YELLOW + "'event-priority.player-portal' config option will only take " +

Check warning on line 491 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
'+' should be on a new line.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:491:122: warning: '+' should be on a new line. (com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck)

Check warning on line 491 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Line is longer than 120 characters (found 122).

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:491:0: warning: Line is longer than 120 characters (found 122). (com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck)
"full effect after a server restart.")))
.build());

final ConfigNode<EventPriority> eventPriorityPlayerRespawn = node(ConfigNode.builder("event-priority.player-respawn", EventPriority.class)
Expand All @@ -487,6 +499,9 @@
.comment("This config option defines the priority for the PlayerRespawnEvent.")
.onLoadAndChange((oldValue, newValue) ->
eventPriorityMapper.get().setPriority("mvcore-player-respawn", newValue))
.onChange((sender, oldValue, newValue) ->
sender.sendMessage(ChatColor.YELLOW + "'event-priority.player-respawn' config option will only take " +

Check warning on line 503 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
'+' should be on a new line.

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:503:123: warning: '+' should be on a new line. (com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck)

Check warning on line 503 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Line is longer than 120 characters (found 123).

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:503:0: warning: Line is longer than 120 characters (found 123). (com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck)
"full effect after a server restart."))
.build());

final ConfigNode<EventPriority> eventPriorityPlayerSpawnLocation = node(ConfigNode.builder("event-priority.player-spawn-location", EventPriority.class)
Expand All @@ -496,6 +511,9 @@
.name("event-priority-player-spawn-location")
.onLoadAndChange((oldValue, newValue) ->
eventPriorityMapper.get().setPriority("mvcore-player-spawn-location", newValue))
.onChange((sender, oldValue, newValue) ->
sender.sendMessage(ChatColor.YELLOW + "'event-priority.player-spawn-location' config option will only take " +

Check warning on line 515 in src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

View workflow job for this annotation

GitHub Actions / checkstyle / checkstyle 

[checkstyle] reported by reviewdog 🐶
Line is longer than 120 characters (found 130).

Raw Output:
/github/workspace/./src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java:515:0: warning: Line is longer than 120 characters (found 130). (com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck)
"full effect after a server restart."))
.build());

final ConfigNode<EventPriority> eventPriorityPlayerTeleport = node(ConfigNode.builder("event-priority.player-teleport", EventPriority.class)
Expand All @@ -505,6 +523,9 @@
.comment("This config option defines the priority for the PlayerTeleportEvent.")
.onLoadAndChange((oldValue, newValue) ->
eventPriorityMapper.get().setPriority("mvcore-player-teleport", newValue))
.onChange((sender, oldValue, newValue) ->
sender.sendMessage(ChatColor.YELLOW + "'event-priority.player-teleport' config option will only take " +
"full effect after a server restart."))
.build());

private final ConfigHeaderNode miscHeader = node(ConfigHeaderNode.builder("misc")
Expand All @@ -517,6 +538,9 @@
.comment("Note: this config option needs a server restart to take effect.")
.defaultValue("bukkit.yml")
.name("bukkit-yml-path")
.onChange(((sender, oldValue, newValue) ->
sender.sendMessage(ChatColor.YELLOW + "'bukkit-yml-path' config option will only take " +
"full effect after a server restart.")))
.build());

final ConfigNode<String> serverPropertiesPath = node(ConfigNode.builder("misc.server-properties-path", String.class)
Expand All @@ -525,6 +549,9 @@
.comment("Note: this config option needs a server restart to take effect.")
.defaultValue("server.properties")
.name("server-properties-path")
.onChange(((sender, oldValue, newValue) ->
sender.sendMessage(ChatColor.YELLOW + "'server-properties-path' config option will only take " +
"full effect after a server restart.")))
.build());

final ConfigNode<Boolean> autoDetectGeneratorPlugins = node(ConfigNode.builder("misc.auto-detect-generator-plugins", Boolean.class)
Expand Down
Loading