Yolo/io.github.eingruenesbeb.yolo.events.deathBan/PreDeathBanEvent

PreDeathBanEvent

class PreDeathBanEvent : Event, YoloPlayerEvent

This event is emitted when a player is about to be death-banned. It is a synchronous variant of PreDeathBanEventAsync, that can change the outcome of the process by using changeOutcome.

It implements YoloPlayerEvent, meaning, that it provides relevant information about the player and access to the corresponding org.bukkit.OfflinePlayer and org.bukkit.entity.Player.

See also

PreYoloPlayerReviveEventAsync

YoloPlayerEvent

PlayerManager.DeathBanResult

Types

object Companion

Functions

open fun callEvent(): Boolean

fun changeOutcome(newTargetResult: PlayerManager.DeathBanResult, by: Plugin, isSilent: Boolean = false, reason: String? = null)

Changes the outcome of the process depending on the new parameters given.

@NotNull

open fun getEventName(): @NotNull String

open override fun getHandlers(): HandlerList

fun isAsynchronous(): Boolean

Properties

associatedPlayerDeathEvent

val associatedPlayerDeathEvent: PlayerDeathEvent

open val offlinePlayer: OfflinePlayer

The corresponding OfflinePlayer.

originalTargetResult

val originalTargetResult: PlayerManager.DeathBanResult

The originally intended outcome of the event

open val player: Player?

The corresponding Player, if they are online. Otherwise, this is null.

open val status: PlayerManager.PlayerStatus

Returns the PlayerStatus contained in yoloPlayerInformation.

var targetResult: PlayerManager.DeathBanResult

The currently targeted outcome of the event.

yoloPlayerInformation

open override val yoloPlayerInformation: Pair<UUID, PlayerManager.PlayerStatus>

The information regarding this player including their current status