vital-minigames/dev.vitalframework.minigames/VitalGlobalMinigameService

VitalGlobalMinigameService

open class VitalGlobalMinigameService(val plugin: SpigotPlugin, val states: List<VitalGlobalMinigameState>)

The global minigame manager to use when creating a global minigame for the entire game server. A minigame consists of multiple states, which all are listeners by default. Only the state that is currently active in this service will receive game-events. Switching to another state means that the previous state will not be an active listener anymore.

Constructors

constructor(plugin: SpigotPlugin, states: List<VitalGlobalMinigameState>)

Properties

plugin

val plugin: SpigotPlugin

state

var state: VitalGlobalMinigameState?

Holds the currently active state. All event handlers defined on this state are active while this state is active. Once switched to another state, all event handlers of the old state will be unregistered, while all event handlers of the new state are registered.

states

val states: List<VitalGlobalMinigameState>

Functions

isStateActive

inline fun <T : VitalGlobalMinigameState> isStateActive(): Boolean

Checks if the given state is active by its class.

setState

inline fun <T : VitalGlobalMinigameState> setState()

Sets the state of the game to the state with the given class. If a state with the given class cannot be found, an exception is thrown.

fun setState(state: VitalGlobalMinigameState)

Sets the state of the game to the given state.