com.cjcrafter.foliascheduler

Interface ServerImplementation

public interface ServerImplementation

Method Summary

Modifier and Type	Method and Description
@NotNull AsyncSchedulerImplementation	async() Returns the async scheduler.
void	cancelTasks() Cancels all scheduled tasks that were scheduled using your Plugin instance.
@NotNull EntitySchedulerImplementation	entity(@NotNull org.bukkit.entity.Entity entity) Returns an entity scheduler.
@NotNull org.bukkit.plugin.Plugin	getOwningPlugin() The plugin used to schedule tasks.
@NotNull GlobalSchedulerImplementation	global() Returns the global region scheduler.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.block.Block block) Returns true if the current thread will be used to tick the region the block is in.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.entity.Entity entity) Returns true if the current thread will be used to tick the region the entity is in.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.Location location) Returns true if the current thread will be used to tick the region the location is in.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.Location location, int squareRadiusChunks) Returns true if the current thread will be used to tick the region the location, and the surrounding area, is in.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.World world, int chunkX, int chunkZ) Returns true if the current thread will be used to tick the region the chunk is in.
boolean	isOwnedByCurrentRegion(@NotNull org.bukkit.World world, int chunkX, int chunkZ, int squareRadiusChunks) Returns true if the current thread will be used to tick the region the chunk is in, and the surrounding area.
default @NotNull RegionSchedulerImplementation	region(@NotNull org.bukkit.block.Block block) Returns a region scheduler.
default @NotNull RegionSchedulerImplementation	region(@NotNull org.bukkit.Chunk chunk) Returns a region scheduler.
default @NotNull RegionSchedulerImplementation	region(@NotNull org.bukkit.Location location) Returns a region scheduler.
@NotNull RegionSchedulerImplementation	region(@NotNull org.bukkit.World world, int chunkX, int chunkZ) Returns a region scheduler.
default @NotNull java.util.concurrent.CompletableFuture<java.lang.Boolean>	teleportAsync(@NotNull org.bukkit.entity.Entity entity, @NotNull org.bukkit.Location location) Teleports an entity to a location.
@NotNull java.util.concurrent.CompletableFuture<java.lang.Boolean>	teleportAsync(@NotNull org.bukkit.entity.Entity entity, @NotNull org.bukkit.Location location, org.bukkit.event.player.PlayerTeleportEvent.TeleportCause cause) Teleports an entity to a location.

Method Detail

getOwningPlugin

@NotNull
@NotNull org.bukkit.plugin.Plugin getOwningPlugin()

The plugin used to schedule tasks.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.Location location)

Returns true if the current thread will be used to tick the region the location is in.

Parameters:

location - The location to check.

Returns:

True if the current thread will be used to tick the region the location is in.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.Location location,
                               int squareRadiusChunks)

Returns true if the current thread will be used to tick the region the location, and the surrounding area, is in.

Parameters:

location - The location to check.

squareRadiusChunks - The radius in chunks to check, as a Chebyshev distance.

Returns:

True if the current thread will be used to tick the region the location is in.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.block.Block block)

Returns true if the current thread will be used to tick the region the block is in.

Parameters:

block - The block to check.

Returns:

True if the current thread will be used to tick the region the block is in.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.World world,
                               int chunkX,
                               int chunkZ)

Returns true if the current thread will be used to tick the region the chunk is in.

Parameters:

world - The world the chunk is in.

chunkX - The x-coordinate of the chunk.

chunkZ - The z-coordinate of the chunk.

Returns:

True if the current thread will be used to tick the region the chunk is in.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.World world,
                               int chunkX,
                               int chunkZ,
                               int squareRadiusChunks)

Returns true if the current thread will be used to tick the region the chunk is in, and the surrounding area.

Parameters:

world - The world the chunk is in.

chunkX - The x-coordinate of the chunk.

chunkZ - The z-coordinate of the chunk.

squareRadiusChunks - The radius in chunks to check, as a Chebyshev distance.

Returns:

True if the current thread will be used to tick the region the chunk is in.

isOwnedByCurrentRegion

boolean isOwnedByCurrentRegion(@NotNull
                               @NotNull org.bukkit.entity.Entity entity)

Returns true if the current thread will be used to tick the region the entity is in.

Parameters:

entity - The entity to check.

Returns:

True if the current thread will be used to tick the region the entity is in.

global

@NotNull
@NotNull GlobalSchedulerImplementation global()

Returns the global region scheduler. On Folia, this will run tasks during server ticks, but separately from any specific region. This is useful for tasks that don't need to be run in a specific region. On Paper/Spigot, all tasks are run in the main thread.

async

@NotNull
@NotNull AsyncSchedulerImplementation async()

Returns the async scheduler. On all servers, this will run tasks asynchronously, separate from the server thread(s). This is useful for I/O-bound tasks or tasks that don't need to be run in the main thread.

entity

@NotNull
@NotNull EntitySchedulerImplementation entity(@NotNull
                                                       @NotNull org.bukkit.entity.Entity entity)

Returns an entity scheduler. On Folia, this will run tasks in the region the entity is in, and will follow the entity as it moves between regions. On Paper/Spigot, this will run tasks in the main thread.

region

@NotNull
@NotNull RegionSchedulerImplementation region(@NotNull
                                                       @NotNull org.bukkit.World world,
                                                       int chunkX,
                                                       int chunkZ)

Returns a region scheduler. On Folia, this will run tasks in the specified region. On Paper/Spigot, this will run tasks in the main thread.

region

@NotNull
default @NotNull RegionSchedulerImplementation region(@NotNull
                                                               @NotNull org.bukkit.Location location)

Returns a region scheduler. On Folia, this will run tasks in the specified region. On Paper/Spigot, this will run tasks in the main thread.

region

@NotNull
default @NotNull RegionSchedulerImplementation region(@NotNull
                                                               @NotNull org.bukkit.block.Block block)

Returns a region scheduler. On Folia, this will run tasks in the specified region. On Paper/Spigot, this will run tasks in the main thread.

region

@NotNull
default @NotNull RegionSchedulerImplementation region(@NotNull
                                                               @NotNull org.bukkit.Chunk chunk)

Returns a region scheduler. On Folia, this will run tasks in the specified region. On Paper/Spigot, this will run tasks in the main thread.

cancelTasks

void cancelTasks()

Cancels all scheduled tasks that were scheduled using your Plugin instance.

Note that Folia implementations will only cancel tasks scheduled using the GlobalSchedulerImplementation and AsyncSchedulerImplementation, ignoring any tasks scheduled using the EntitySchedulerImplementation and RegionSchedulerImplementation.

See Also:

AsyncSchedulerImplementation.cancelTasks(), GlobalSchedulerImplementation.cancelTasks(), Issue #28

teleportAsync

@NotNull
default @NotNull java.util.concurrent.CompletableFuture<java.lang.Boolean> teleportAsync(@NotNull
                                                                                                  @NotNull org.bukkit.entity.Entity entity,
                                                                                                  @NotNull
                                                                                                  @NotNull org.bukkit.Location location)

Teleports an entity to a location. If chunks need to be loaded, those chunks will be loaded asynchronously. Shortcut for teleportAsync(Entity, Location, PlayerTeleportEvent.TeleportCause).

Parameters:

entity - The entity to teleport

location - The location to teleport the entity to

Returns:

A future that completes when the entity is teleported, or the teleport fails

teleportAsync

@NotNull
@NotNull java.util.concurrent.CompletableFuture<java.lang.Boolean> teleportAsync(@NotNull
                                                                                          @NotNull org.bukkit.entity.Entity entity,
                                                                                          @NotNull
                                                                                          @NotNull org.bukkit.Location location,
                                                                                          @NotNull
                                                                                          org.bukkit.event.player.PlayerTeleportEvent.TeleportCause cause)

Teleports an entity to a location. If chunks need to be loaded, those chunks will be loaded asynchronously.

The returned future will complete when the entity is teleported, or the teleport fails. If the teleport fails, the future will complete with a value of false.

Note that this method is only asynchronous on Paper servers, versions 1.13 and later. On other servers, this method will be delegated to a synchronous task that executes Entity.teleport(Location) in the main thread (which may lead to lag spikes).

Parameters:

entity - The entity to teleport

location - The location to teleport the entity to

cause - The cause of the teleport

Returns:

A future that completes when the entity is teleported, or the teleport fails