twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-09 16:42:03 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add Plugin Chunk Ticket API

Browse Source 
Allows plugins to force certain chunks to be kept loaded for as long as they are enabled.

By: Spottedleaf <Spottedleaf@users.noreply.github.com>
This commit is contained in:
Bukkit/Spigot
2019-07-08 12:14:29 +10:00
parent 6df381566e
commit 7bfc0554c2
3 changed files with 149 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
paper-api/src/main/java/org/bukkit/Chunk.java
View File

@@ -1,8 +1,10 @@
package org.bukkit;
import java.util.Collection;
import org.bukkit.block.Block;
import org.bukkit.block.BlockState;
import org.bukkit.entity.Entity;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;
/**
@@ -147,4 +149,53 @@ public interface Chunk {
* @see World#setChunkForceLoaded(int, int, boolean)
*/
void setForceLoaded(boolean forced);
/**
* Adds a plugin ticket for this chunk, loading this chunk if it is not
* already loaded.
* <p>
* A plugin ticket will prevent a chunk from unloading until it is
* explicitly removed. A plugin instance may only have one ticket per chunk,
* but each chunk can have multiple plugin tickets.
* </p>
*
* @param plugin Plugin which owns the ticket
* @return {@code true} if a plugin ticket was added, {@code false} if the
* ticket already exists for the plugin
* @throws IllegalStateException If the specified plugin is not enabled
* @see World#addPluginChunkTicket(int, int, Plugin)
*/
boolean addPluginChunkTicket(@NotNull Plugin plugin);
/**
* Removes the specified plugin's ticket for this chunk
* <p>
* A plugin ticket will prevent a chunk from unloading until it is
* explicitly removed. A plugin instance may only have one ticket per chunk,
* but each chunk can have multiple plugin tickets.
* </p>
*
* @param plugin Plugin which owns the ticket
* @return {@code true} if the plugin ticket was removed, {@code false} if
* there is no plugin ticket for the chunk
* @see World#removePluginChunkTicket(int, int, Plugin)
*/
boolean removePluginChunkTicket(@NotNull Plugin plugin);
/**
* Retrieves a collection specifying which plugins have tickets for this
* chunk. This collection is not updated when plugin tickets are added or
* removed to this chunk.
* <p>
* A plugin ticket will prevent a chunk from unloading until it is
* explicitly removed. A plugin instance may only have one ticket per chunk,
* but each chunk can have multiple plugin tickets.
* </p>
*
* @return unmodifiable collection containing which plugins have tickets for
* this chunk
* @see World#getPluginChunkTickets(int, int)
*/
@NotNull
Collection<Plugin> getPluginChunkTickets();
}