vital-minigames/dev.vitalframework.minigames/VitalMinigameInstanceCountdownState

VitalMinigameInstanceCountdownState

open class VitalMinigameInstanceCountdownState<T : VitalMinigameInstance>(val instance: T) : VitalCountdownTask.Spigot, VitalMinigameInstanceState<T>

Defines a single game instance state within an active minigame instance, that is capable of running as a countdown task. All event handlers registered here will only be active, when this state is active in its registered game instance. A state may perform mutation on its own instance that's passed to its constructor to modify game data.

@GlobalMinigameState
public class MyCountdownMinigameInstanceState extends VitalCountdownMinigameState<MyMinigameInstance> {
  public MyCountdownMinigameInstanceState(MyMinigameInstance instance) {
    super(instance);
  }
}

Constructors

VitalMinigameInstanceCountdownState

constructor(instance: T)

Properties

var allowTick: Boolean

var countdown: Long

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

open override val instance: T

The instance this state belongs to. Each instance may have its own data. e.g. its designated state instances you may switch to.

open val logger: Logger

val plugin: SpigotPlugin

var runnable: SpigotRunnable?

val running: Boolean

var task: SpigotTask?

Functions

open override fun cancelRunnable()

open override fun cancelTask()

open override fun createRunnable(): SpigotRunnable

open override fun createTask(): SpigotTask

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

fun handleTick()

open fun onDisable()

Lifecycle function; called when this state is disabled on its registered instance.

open fun onEnable()

Lifecycle function; called when this state is enabled on its registered instance.

open fun onExpire()

open fun onReset()

open fun onRestart()

open fun onStart()

open fun onStop()

open fun onTick()

fun reset()

fun start()

fun stop()