Fixes and speed improvement

- added config parameter to define the number of chunks that should be generated per step
- probably fixed #3 by processing or canceling pending chunks before the world is saved

README.md

@@ -39,13 +39,18 @@ generation:
   # The value should be a positive integer.
   period: 2
 
+  # The max amount of chunks that should be generated per step.
+  # Higher values mean higher generation speed but higher performance impact.
+  # The value should be a positive integer.
+  chunks-per-step: 4
+
   # Paper Only
   # The number of already generated chunks that will be skipped for each step.
   # Notice that these still have a performance impact because the server needs to check
   # if the chunk is generated.
   # Higher values mean faster generation but greater performance impact.
   # The value should be a positive integer.
-  chunks-skips-per-step: 5
+  chunk-skips-per-step: 100
 
   # The maximum milliseconds per tick the server is allowed to have
   # during the cunk generation process.

build.gradle

@@ -22,7 +22,7 @@ idea {
 }
 
 group "net.trivernis"
-version "0.11-beta"
+version "0.12-beta"
 
 sourceCompatibility = 1.8
 

src/main/kotlin/net/trivernis/chunkmaster/Chunkmaster.kt

@@ -32,8 +32,8 @@ class Chunkmaster: JavaPlugin() {
         generationManager = GenerationManager(this, server)
         generationManager.init()
 
-        getCommand("chunkmaster")?.setExecutor(CommandChunkmaster(this, server))
         getCommand("chunkmaster")?.aliases = mutableListOf("chm", "chunkm", "cmaster")
+        getCommand("chunkmaster")?.setExecutor(CommandChunkmaster(this, server))
 
         server.pluginManager.registerEvents(ChunkmasterEvents(this, server), this)
 
@@ -60,7 +60,8 @@ class Chunkmaster: JavaPlugin() {
     private fun configure() {
         dataFolder.mkdir()
         config.addDefault("generation.period", 2L)
-        config.addDefault("generation.chunks-skips-per-step", 10)
+        config.addDefault("generation.chunks-per-step", 4)
+        config.addDefault("generation.chunk-skips-per-step", 100)
         config.addDefault("generation.mspt-pause-threshold", 500L)
         config.addDefault("generation.pause-on-join", true)
         config.addDefault("generation.max-pending-chunks", 10)

src/main/kotlin/net/trivernis/chunkmaster/ChunkmasterEvents.kt

@@ -1,10 +1,12 @@
 package net.trivernis.chunkmaster
 
+import net.trivernis.chunkmaster.lib.generation.GenerationTaskPaper
 import org.bukkit.Server
 import org.bukkit.event.EventHandler
 import org.bukkit.event.Listener
 import org.bukkit.event.player.PlayerJoinEvent
 import org.bukkit.event.player.PlayerQuitEvent
+import org.bukkit.event.world.WorldSaveEvent
 
 class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server: Server) : Listener {
 
@@ -21,8 +23,8 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server
                 server.onlinePlayers.isEmpty()
             ) {
                 if (!playerPaused) {
-                    chunkmaster.generationManager.resumeAll()
                     chunkmaster.logger.info("Server is empty. Resuming chunk generation tasks.")
+                    chunkmaster.generationManager.resumeAll()
                 } else if (chunkmaster.generationManager.paused){
                     chunkmaster.logger.info("Generation was manually paused. Not resuming automatically.")
                     playerPaused = chunkmaster.generationManager.paused
@@ -40,9 +42,22 @@ class ChunkmasterEvents(private val chunkmaster: Chunkmaster, private val server
     fun onPlayerJoin(event: PlayerJoinEvent) {
         if (pauseOnJoin) {
             if (server.onlinePlayers.size == 1 || server.onlinePlayers.isEmpty()) {
+                chunkmaster.logger.info("Pausing generation tasks because of player join.")
                 playerPaused = chunkmaster.generationManager.paused
                 chunkmaster.generationManager.pauseAll()
-                chunkmaster.logger.info("Pausing generation tasks because of player join.")
+            }
+        }
+    }
+
+    /**
+     * Unload all chunks before a save.
+     */
+    @EventHandler
+    fun onWorldSave(event: WorldSaveEvent) {
+        val task = chunkmaster.generationManager.tasks.find { it.generationTask.world == event.world }
+        if (task != null) {
+            if (task.generationTask is GenerationTaskPaper) {
+                task.generationTask.unloadAllChunks()
             }
         }
     }

src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTask.kt

@@ -22,6 +22,7 @@ abstract class GenerationTask(plugin: Chunkmaster, centerChunk: Chunk, startChun
     protected val chunkSkips = plugin.config.getInt("generation.chunks-skips-per-step")
     protected val msptThreshold = plugin.config.getLong("generation.mspt-pause-threshold")
     protected val maxLoadedChunks = plugin.config.getInt("generation.max-loaded-chunks")
+    protected val chunksPerStep = plugin.config.getInt("generation.chunks-per-step")
 
     protected var endReachedCallback: (() -> Unit)? = null
         private set

src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskPaper.kt

@@ -51,9 +51,14 @@ class GenerationTaskPaper(
                     }
                 }
 
+                if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) {
+                    for (i in 0 until chunksPerStep) {
                         if (!PaperLib.isChunkGenerated(world, chunk.x, chunk.z)) {
                             pendingChunks.add(PaperLib.getChunkAtAsync(world, chunk.x, chunk.z, true))
                         }
+                        chunk = nextChunkCoordinates
+                    }
+                }
                 lastChunkCoords = chunk
                 count = spiral.count // set the count to the more accurate spiral count
             }
@@ -66,6 +71,13 @@ class GenerationTaskPaper(
      * This unloads all chunks that were generated but not unloaded yet.
      */
     override fun cancel() {
+        unloadAllChunks()
+    }
+
+    /**
+     * Cancels all pending chunks and unloads all loaded chunks.
+     */
+    fun unloadAllChunks() {
         for (pendingChunk in pendingChunks) {
             if (pendingChunk.isDone) {
                 loadedChunks.add(pendingChunk.get())

src/main/kotlin/net/trivernis/chunkmaster/lib/generation/GenerationTaskSpigot.kt

@@ -37,12 +37,15 @@ class GenerationTaskSpigot(
                     return
                 }
 
-                val chunk = nextChunkCoordinates
+                var chunk = nextChunkCoordinates
 
                 if (!world.isChunkGenerated(chunk.x, chunk.z)) {
+                    for (i in 0 until chunksPerStep) {
                         val chunkInstance = world.getChunkAt(chunk.x, chunk.z)
                         chunkInstance.load(true)
                         loadedChunks.add(chunkInstance)
+                        chunk = nextChunkCoordinates
+                    }
                 }
                 lastChunkCoords = chunk
                 count = spiral.count // set the count to the more accurate spiral count

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 main: net.trivernis.chunkmaster.Chunkmaster
 name: Chunkmaster
-version: '0.11-beta'
+version: '0.12-beta'
 description: Chunk commands plugin.
 author: Trivernis
 website: trivernis.net