vital-tasks/dev.vitalframework.tasks/VitalCountdownTask

VitalCountdownTask

abstract class VitalCountdownTask<P, R : Runnable, T>(val plugin: P) : VitalHasInfo

Defines a countdown task within the Vital framework. A countdown task may perform an action that can end after a set countdown.

By default, a countdown task will not be a Spring bean. That means that Vital will not automatically create an instance of it. This is because countdown tasks are also meant to be used by vital-minigames, where each instanced-game may have multiple running countdowns that are not scoped to the entire server.

A countdown task can be marked as "autoStart" to automatically start it when a new instance is created. This functionality is disabled by default.

@VitalCountdownTask.Info(interval = 1_000, countdown = 10, autoStart = false)
public class MyCountdownTask extends VitalCountdownTask.Spigot {
    public MyCountdownState(JavaPlugin plugin) {
        super(plugin);
    }

    @Override
    public void onTick() {
        // ...
    }

    @Override
    public void onExpire() {
        // ...
    }
}

Inheritors

Spigot

Bungee

Constructors

VitalCountdownTask

constructor(plugin: P)

Types

Bungee

open class Bungee(plugin: BungeePlugin) : VitalCountdownTask<BungeePlugin, BungeeRunnable, BungeeTask>

Info

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Info(val countdown: Long, val interval: Long, val autoStart: Boolean = false)

Defines the info for a VitalCountdownTask.

Spigot

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

Properties

allowTick

var allowTick: Boolean

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

countdown

var countdown: Long

The current countdown of this task.

info

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

plugin

val plugin: P

runnable

var runnable: R?

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

running

val running: Boolean

Checks if this task is currently running.

task

var task: T?

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

Functions

cancelRunnable

abstract fun cancelRunnable()

Cancels the internal runnable for this task.

cancelTask

abstract fun cancelTask()

Cancels the internal task for this task.

createRunnable

abstract fun createRunnable(): R

Creates the internal runnable for this task.

createTask

abstract fun createTask(): T

Creates the internal runnable for this task.

getInfo

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

handleTick

fun handleTick()

Handles a single tick of this task, decreases the countdown and calls the onTick lifecycle function.

onExpire

open fun onExpire()

Lifecycle function; called when this task's countdown reaches 0.

onReset

open fun onReset()

Lifecycle function; called when this task is reset via reset.

onRestart

open fun onRestart()

Lifecycle function; called when this task is restarted via restart.

onStart

open fun onStart()

Lifecycle function; called when this task is started.

onStop

open fun onStop()

Lifecycle function; called when this task is stopped.

onTick

open fun onTick()

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

reset

fun reset()

Resets this task by setting the countdown to its initial value defined in Info and calls the onReset lifecycle function.

restart

fun restart()

Restarts this task by stopping it via stop, resetting it's countdown via reset, starting the task again via start and finally calling the onRestart lifecycle function.

start

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.

stop

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.