endstone/scheduler

Classes

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

Type Aliases

Name	Description
`TaskId`

`class`Scheduler

Defined in <endstone/scheduler/scheduler.h>

Represents a scheduler that executes various tasks.

Methods

Name	Description
`~Scheduler`
`runTask`
`runTaskLater`
`runTaskTimer`
`runTaskAsync`	Returns a task that will be executed asynchronously on the next server tick.
`runTaskLaterAsync`	Returns a task that will be executed asynchronously after the specified number of server ticks.
`runTaskTimerAsync`	Returns a task that will be executed repeatedly (and asynchronously) until cancelled, starting after the specified number of server ticks.
`cancelTask`
`cancelTasks`
`isRunning`
`isQueued`
`getPendingTasks`

`meth`~Schedulervirtual

~Scheduler() =default

`meth`runTaskabstract

std::shared_ptr<Task> runTask(Plugin& plugin, std::function<void()> task) =0

Returns a task that will be executed synchronously on the next server tick.

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`runTaskLaterabstract

std::shared_ptr<Task> runTaskLater(Plugin& plugin, std::function<void()> task, std::uint64_t delay) =0

Returns a task that will be executed synchronously after the specified number of server ticks.

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run
`delay`	`std::uint64_t`	the ticks to wait before running the task

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`runTaskTimerabstract

std::shared_ptr<Task> runTaskTimer(Plugin& plugin, std::function<void()> task, std::uint64_t delay, std::uint64_t period) =0

Returns a task that will be executed repeatedly (and synchronously) until cancelled, starting after the specified number of server ticks.

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run
`delay`	`std::uint64_t`	the ticks to wait before running the task
`period`	`std::uint64_t`	the ticks to wait between runs

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`runTaskAsyncabstract

std::shared_ptr<Task> runTaskAsync(Plugin& plugin, std::function<void()> task) =0

Returns a task that will be executed asynchronously on the next server tick.

Remark

Asynchronous tasks should never access any Endstone API

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`runTaskLaterAsyncabstract

std::shared_ptr<Task> runTaskLaterAsync(Plugin& plugin, std::function<void()> task, std::uint64_t delay) =0

Returns a task that will be executed asynchronously after the specified number of server ticks.

Remark

Asynchronous tasks should never access any Endstone API

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run
`delay`	`std::uint64_t`	the ticks to wait before running the task

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`runTaskTimerAsyncabstract

std::shared_ptr<Task> runTaskTimerAsync(Plugin& plugin, std::function<void()> task, std::uint64_t delay, std::uint64_t period) =0

Returns a task that will be executed repeatedly (and asynchronously) until cancelled, starting after the specified number of server ticks.

Remark

Asynchronous tasks should never access any Endstone API

Parameters

Name	Type	Description
`plugin`	`Plugin&`	the reference to the plugin scheduling task
`task`	`std::function<void()>`	the task to be run
`delay`	`std::uint64_t`	the ticks to wait before running the task
`period`	`std::uint64_t`	the ticks to wait between runs

Returns

Type	Description
`std::shared_ptr<Task>`	a Task that contains the id number (nullptr if task is empty)

`meth`cancelTaskabstract

void cancelTask(TaskId id) =0

Removes task from scheduler.

Parameters

Name	Type	Description
`taskId`		Id number of task to be removed

`meth`cancelTasksabstract

void cancelTasks(Plugin& plugin) =0

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

Parameters

Name	Type	Description
`plugin`	`Plugin&`	Owner of tasks to be removed

`meth`isRunningabstract

bool isRunning(TaskId id) =0

Check if the task currently running.

Parameters

Name	Type	Description
`taskId`		The task to check.

Returns

Type	Description
`bool`	If the task is currently running.

`meth`isQueuedabstract

bool isQueued(TaskId id) =0

Check if the task queued to be run later.

Parameters

Name	Type	Description
`taskId`		The task to check.

Returns

Type	Description
`bool`	If the task is queued to be run.

`meth`getPendingTasksabstract

std::vector<Task*> getPendingTasks() =0

Returns a vector of all pending tasks.

The ordering of the tasks is NOT related to their order of execution.

Returns

Type	Description
`std::vector<Task*>`	Pending tasks

`class`Task

Defined in <endstone/scheduler/task.h>

Represents a task being executed by the scheduler.

Methods

Name	Description
`~Task`
`getTaskId`
`getOwner`
`isSync`
`isCancelled`
`cancel`

`meth`~Taskvirtual

~Task() =default

`meth`getTaskIdabstractconst

TaskId getTaskId() const =0

Returns the taskId for the task.

Returns

Type	Description
`TaskId`	Task id number

`meth`getOwnerabstractconst

Plugin* getOwner() const =0

Returns the Plugin that owns this task.

Returns

Type	Description
`Plugin*`	The Plugin that owns the task

`meth`isSyncabstractconst

bool isSync() const =0

Returns true if the Task is a sync task.

Returns

Type	Description
`bool`	true if the task is run by server thread

`meth`isCancelledabstractconst

bool isCancelled() const =0

Returns true if this task has been cancelled.

Returns

Type	Description
`bool`	true if the task has been cancelled

`meth`cancelabstract

void cancel() =0

Attempts to cancel this task.

`type`TaskId

std::uint32_t TaskId

endstone/scheduler

classScheduler

meth~Schedulervirtual

methrunTaskabstract

methrunTaskLaterabstract

methrunTaskTimerabstract

methrunTaskAsyncabstract

methrunTaskLaterAsyncabstract

methrunTaskTimerAsyncabstract

methcancelTaskabstract

methcancelTasksabstract

methisRunningabstract

methisQueuedabstract

methgetPendingTasksabstract

classTask

meth~Taskvirtual

methgetTaskIdabstractconst

methgetOwnerabstractconst

methisSyncabstractconst

methisCancelledabstractconst

methcancelabstract

typeTaskId

On this page

`class`Scheduler

`meth`~Schedulervirtual

`meth`runTaskabstract

`meth`runTaskLaterabstract

`meth`runTaskTimerabstract

`meth`runTaskAsyncabstract

`meth`runTaskLaterAsyncabstract

`meth`runTaskTimerAsyncabstract

`meth`cancelTaskabstract

`meth`cancelTasksabstract

`meth`isRunningabstract

`meth`isQueuedabstract

`meth`getPendingTasksabstract

`class`Task

`meth`~Taskvirtual

`meth`getTaskIdabstractconst

`meth`getOwnerabstractconst

`meth`isSyncabstractconst

`meth`isCancelledabstractconst

`meth`cancelabstract

`type`TaskId