Files
ms/packages/bukkit/src/typings/org.bukkit.Chunk.ts
2019-09-24 15:02:03 +08:00

108 lines
4.0 KiB
TypeScript

declare namespace org {
namespace bukkit {
// @ts-ignore
interface Chunk {
/**
* Gets the X-coordinate of this chunk
*/
getX(): number;
/**
* Gets the Z-coordinate of this chunk
*/
getZ(): number;
/**
* Gets the world containing this chunk
*/
getWorld(): org.bukkit.World;
/**
* Gets a block from this chunk
*/
getBlock(x: number, y: number, z: number): org.bukkit.block.Block;
/**
* Capture thread-safe read-only snapshot of chunk data
*/
getChunkSnapshot(): org.bukkit.ChunkSnapshot;
/**
* Capture thread-safe read-only snapshot of chunk data
*/
getChunkSnapshot(includeMaxblocky: boolean, includeBiome: boolean, includeBiomeTempRain: boolean): org.bukkit.ChunkSnapshot;
/**
* Get a list of all entities in the chunk.
*/
getEntities(): org.bukkit.entity.Entity[];
/**
* Get a list of all tile entities in the chunk.
*/
getTileEntities(): org.bukkit.block.BlockState[];
/**
* Checks if the chunk is loaded.
*/
isLoaded(): boolean;
/**
* Loads the chunk.
*/
load(generate: boolean): boolean;
/**
* Loads the chunk.
*/
load(): boolean;
/**
* Unloads and optionally saves the Chunk
*/
unload(save: boolean): boolean;
/**
* Unloads and optionally saves the Chunk
*/
unload(): boolean;
/**
* Checks if this chunk can spawn slimes without being a swamp biome.
*/
isSlimeChunk(): boolean;
/**
* Gets whether the chunk at the specified chunk coordinates is force
* loaded.
* <p>
* A force loaded chunk will not be unloaded due to lack of player activity.
*/
isForceLoaded(): boolean;
/**
* Sets whether the chunk at the specified chunk coordinates is force
* loaded.
* <p>
* A force loaded chunk will not be unloaded due to lack of player activity.
*/
setForceLoaded(forced: boolean): void;
/**
* 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>
*/
addPluginChunkTicket(plugin: org.bukkit.plugin.Plugin): boolean;
/**
* 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>
*/
removePluginChunkTicket(plugin: org.bukkit.plugin.Plugin): boolean;
/**
* 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>
*/
getPluginChunkTickets(): any[] /*java.util.Collection*/;
}
}
}