Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-28 05:35:44 +01:00
Code Issues Projects Releases Wiki Activity

Improved documentation in CleanSuperFlatListener

Browse Source
This commit is contained in:
Florian CUNY 2019-01-22 14:26:00 +01:00
parent 9af389ce1d
commit eb8f25f319
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/main/java/world/bentobox/bentobox/listeners/flags/CleanSuperFlatListener.java
View File

@ -1,6 +1,3 @@
/**
*
*/
package world.bentobox.bentobox.listeners.flags; package world.bentobox.bentobox.listeners.flags;
import java.util.LinkedList; import java.util.LinkedList;
@ -15,6 +12,8 @@ import org.bukkit.event.EventPriority;
import org.bukkit.event.world.ChunkLoadEvent; import org.bukkit.event.world.ChunkLoadEvent;
import org.bukkit.scheduler.BukkitTask; import org.bukkit.scheduler.BukkitTask;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import world.bentobox.bentobox.BentoBox; import world.bentobox.bentobox.BentoBox;
import world.bentobox.bentobox.api.events.BentoBoxReadyEvent; import world.bentobox.bentobox.api.events.BentoBoxReadyEvent;
import world.bentobox.bentobox.api.flags.FlagListener; import world.bentobox.bentobox.api.flags.FlagListener;
@ -25,12 +24,29 @@ import world.bentobox.bentobox.util.Pair;
* Cleans super-flat world chunks or normal nether chunks if they generate accidentally * Cleans super-flat world chunks or normal nether chunks if they generate accidentally
* due to lack of a generator being loaded * due to lack of a generator being loaded
* @author tastybento * @author tastybento
*
*/ */
public class CleanSuperFlatListener extends FlagListener { public class CleanSuperFlatListener extends FlagListener {
private Queue<Pair<Integer, Integer>> chunkQ = new LinkedList<>(); /**
* Stores pairs of X,Z coordinates of chunks that need to be regenerated.
* @since 1.1
*/
@NonNull
private Queue<@NonNull Pair<@NonNull Integer, @NonNull Integer>> chunkQueue = new LinkedList<>();
/**
* Task that runs each tick to regenerate chunks that are in the {@link #chunkQueue}.
* It does on at a time.
* @since 1.1
*/
@Nullable
private BukkitTask task; private BukkitTask task;
/**
* Whether BentoBox is ready or not.
* This helps to avoid hanging out the server on startup as a lot of {@link ChunkLoadEvent} are called at this time.
* @since 1.1
*/
private boolean ready; private boolean ready;
@EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true)
@ -53,13 +69,13 @@ public class CleanSuperFlatListener extends FlagListener {
return; return;
} }
// Add to queue // Add to queue
chunkQ.add(new Pair<>(e.getChunk().getX(), e.getChunk().getZ())); chunkQueue.add(new Pair<>(e.getChunk().getX(), e.getChunk().getZ()));
if (task == null) { if (task == null) {
task = Bukkit.getScheduler().runTaskTimer(plugin, () -> { task = Bukkit.getScheduler().runTaskTimer(plugin, () -> {
if (!chunkQ.isEmpty()) { if (!chunkQueue.isEmpty()) {
Pair<Integer, Integer> chunkXZ = chunkQ.poll(); Pair<Integer, Integer> chunkXZ = chunkQueue.poll();
world.regenerateChunk(chunkXZ.x, chunkXZ.z); // NOSONAR - the deprecation doesn't the cause any issues to us world.regenerateChunk(chunkXZ.x, chunkXZ.z); // NOSONAR - the deprecation doesn't cause any issues to us
plugin.log(chunkQ.size() + " Regenerating superflat chunk " + world.getName() + " " + chunkXZ.x + ", " + chunkXZ.z); plugin.log(chunkQueue.size() + " Regenerating superflat chunk " + world.getName() + " " + chunkXZ.x + ", " + chunkXZ.z);
} }
}, 0L, 1L); }, 0L, 1L);
} }