vital-tasks/dev.vitalframework.tasks/VitalRepeatableTask/Spigot

Spigot

open class Spigot(plugin: SpigotPlugin) : VitalRepeatableTask<SpigotPlugin, SpigotRunnable, SpigotTask>

Constructors

constructor(plugin: SpigotPlugin)

Properties

var allowTick: Boolean

Controls if this task can currently tick and call the onTick lifecycle function.

open override val info: MutableMap<Class<VitalRepeatableTask.Info>, VitalRepeatableTask.Info>

val plugin: SpigotPlugin

var runnable: SpigotRunnable?

The internal task that runs to call the onTick lifecycle function. This field will be null if this task is currently not running.

val running: Boolean

Checks if this task is currently running.

var task: SpigotTask?

The internal task that's runs the runnable to call the onTick lifecycle function. This field will be null if this task is currently not running.

Functions

open override fun cancelRunnable()

Cancels the internal runnable for this task.

open override fun cancelTask()

Cancels the internal task for this task.

open override fun createRunnable(): SpigotRunnable

Creates the internal runnable for this task.

open override fun createTask(): SpigotTask

Creates the internal runnable for this task.

open fun <T : Annotation> getInfo(type: Class<T>): T

fun handleTick()

Handles a single tick of this task and calls the onTick lifecycle function. If ticks are disabled by allowTick, this function does nothing.

open fun onStart()

Lifecycle function; called when this task is started.

open fun onStop()

Lifecycle function; called when this task is stopped.

open fun onTick()

Lifecycle function; called when this task is ticked. This task will only tick if allowTick is true.

fun start()

Starts this task if It's not already running. This function will call createRunnable and createTask to set up this task before starting the internal tick timer. The onStart lifecycle function will be called after this task is ready for execution.

fun stop()

Stops this task if It's currently running. This function stops and cleans up the internal runnable and task and then calls the onStop lifecycle function.