scheduler/com.peco2282.devcore.scheduler

Package-level declarations

Types

BukkitDispatcher

class BukkitDispatcher(val plugin: Plugin) : CoroutineDispatcher

A CoroutineDispatcher that dispatches blocks to the Bukkit scheduler.

BukkitTaskHandle

class BukkitTaskHandle(plugin: Plugin, task: BukkitTask) : TaskHandle

A TaskHandle implementation for Bukkit tasks.

Condition

fun interface Condition

Represents a condition that can be evaluated to determine if a task should run.

ConditionalRepeating

class ConditionalRepeating(scheduler: Scheduler, delay: Ticks = ZERO, period: Ticks = ZERO) : Runner

A Runner that executes a task repeatedly as long as a condition is met.

CoroutineTaskHandle

class CoroutineTaskHandle(plugin: Plugin, job: Job) : TaskHandle

A TaskHandle implementation for Coroutine jobs.

PlayerOnline

class PlayerOnline(player: Player) : Condition

A condition that is met if the player is online.

PluginRegistory

object PluginRegistory

Registry for managing Scheduler instances per Plugin.

RunLimit

class RunLimit(max: Int) : Condition

A condition that is met until the number of executions reaches max.

Runner

interface Runner

Interface for executing tasks.

Scheduler

class Scheduler(plugin: Plugin)

Wrapper for the Bukkit scheduler.

TaskBuilder

class TaskBuilder(plugin: Plugin)

DSL for building and scheduling tasks.

TaskHandle

interface TaskHandle

Represents a handle to a scheduled task.

TaskManager

class TaskManager(plugin: Plugin)

Manages scheduled tasks and their lifecycle.

ThenScope

class ThenScope(plugin: Plugin, delay: Ticks) : Runner

Scope for chaining tasks that should execute sequentially with a delay.

Ticks

@JvmInline

value class Ticks(val value: Long)

Represents a duration in Minecraft ticks.

TimeLimit

class TimeLimit(duration: Ticks) : Condition

A condition that is met until the specified duration has passed.

Properties

Always

val Always: Condition

A condition that is always met.

minutes

val Int.minutes: Ticks

Converts this Int minutes to Ticks.

Never

val Never: Condition

A condition that is never met.

scheduler

val Plugin.scheduler: Scheduler

The Scheduler instance for this plugin.

seconds

val Double.seconds: Ticks

val Float.seconds: Ticks

val Int.seconds: Ticks

Converts this Int seconds to Ticks.

taskCreate

val Plugin.taskCreate: TaskBuilder

Creates a new TaskBuilder for this plugin.

taskManager

val Plugin.taskManager: TaskManager

The TaskManager instance for this plugin.

ticks

val Int.ticks: Ticks

Converts this Int to Ticks.

val Long.ticks: Ticks

Converts this Long to Ticks.

ZERO

val ZERO: Ticks

Functions

removeScheduler

fun Plugin.removeScheduler(): Unit?

Removes the scheduler for this plugin and cancels all associated tasks.

taskAfter

fun Player.taskAfter(plugin: Plugin, delay: Ticks, task: () -> Unit): TaskHandle

Schedules a task to run after the specified delay and tracks it for this Player.

taskLaunch

fun World.taskLaunch(plugin: Plugin, block: suspend CoroutineScope.() -> Unit): TaskHandle

Launches a coroutine on the Bukkit main thread and tracks it for this World.

fun Player.taskLaunch(plugin: Plugin, block: suspend CoroutineScope.() -> Unit): TaskHandle

Launches a coroutine on the Bukkit main thread and tracks it for this Player.

taskTimer

fun World.taskTimer(plugin: Plugin, delay: Ticks, period: Ticks, task: () -> Unit): TaskHandle

Schedules a repeated task with the specified delay and period and tracks it for this World.

then

infix fun TaskHandle.then(delay: Ticks): ThenScope

Chains a task to be executed after the current task with the specified delay.