endstone.scheduler

Classes relating to letting plugins run code at specific time intervals.

Classes

Name	Description
`Scheduler`	Represents a scheduler that executes various tasks
`Task`	Represents a task being executed by the scheduler

`class`Scheduler

Scheduler()

Represents a scheduler that executes various tasks

Methods

Name	Description
`cancel_task`	Removes task from scheduler.
`cancel_tasks`	Removes all tasks associated with a particular plugin from the scheduler.
`get_pending_tasks`	Returns a vector of all pending tasks.
`is_queued`	Check if the task queued to be run later.
`is_running`	Check if the task currently running.
`run_task`	Returns a task that will be executed synchronously

`meth`cancel_task

cancel_task(id: int) -> None

Removes task from scheduler.

`meth`cancel_tasks

cancel_tasks(plugin: Plugin) -> None

Removes all tasks associated with a particular plugin from the scheduler.

`meth`get_pending_tasks

get_pending_tasks() -> list[Task]

Returns a vector of all pending tasks.

`meth`is_queued

is_queued(id: int) -> bool

Check if the task queued to be run later.

`meth`is_running

is_running(id: int) -> bool

Check if the task currently running.

`meth`run_task

run_task(plugin: Plugin, task: Callable[[], None], delay: int = 0, period: int = 0) -> Task

Returns a task that will be executed synchronously

`class`Task

Task()

Represents a task being executed by the scheduler

Methods

Name	Description
`cancel`	Attempts to cancel this task.

Attributes

Name	Type	Description
`is_cancelled`	`bool`	Returns true if the task has been cancelled.
`is_sync`	`bool`	Returns true if the task is run by server thread.
`owner`	`Plugin`	Returns the Plugin that owns the task.
`task_id`	`int`	Returns the task id.

`attr`is_cancelledproperty

is_cancelled: bool

Returns true if the task has been cancelled.

`attr`is_syncproperty

is_sync: bool

Returns true if the task is run by server thread.

`attr`ownerproperty

owner: Plugin

Returns the Plugin that owns the task.

`attr`task_idproperty

task_id: int

Returns the task id.

`meth`cancel

cancel() -> None

Attempts to cancel this task.

endstone.scheduler

classScheduler

methcancel_task

methcancel_tasks

methget_pending_tasks

methis_queued

methis_running

methrun_task

classTask

attris_cancelledproperty

attris_syncproperty

attrownerproperty

attrtask_idproperty

methcancel

On this page