vital-players/dev.vitalframework.players

Package-level declarations

Types

abstract class VitalPlayer<T>(val player: T) : VitalEntity<UUID>

Base custom player class for every platform implementation of vital-players. Developers should very rarely use this class manually and rather use Spigot or Bungee instead.

VitalPlayerException

abstract class VitalPlayerException(message: String, cause: Throwable? = null) : RuntimeException

Internal exception; thrown during VitalPlayer lifecycle.

VitalPlayerListener

interface VitalPlayerListener

Internal listener; manages VitalPlayer lifecycles.

VitalPlayerRepository

class VitalPlayerRepository : VitalRepository<VitalPlayer<*>, UUID>

Global repository; stores all instances of VitalPlayer. Use this class to retrieve your custom instances.

VitalPlayersConfigurationProperties

@ConfigurationProperties(prefix = "vital.players")

@Component

class VitalPlayersConfigurationProperties

VitalPlayerService

class VitalPlayerService(vitalPlayerRepository: VitalPlayerRepository)

Internal class; used to create and destroy custom instances of VitalPlayer that are configured via vital.players.player-class-name.

VitalPlayersModule

class VitalPlayersModule(val vitalPlayersConfigurationProperties: VitalPlayersConfigurationProperties) : VitalModule