Terix-API/dev.racci.terix.api.events/PlayerOriginChangeEvent

PlayerOriginChangeEvent

class PlayerOriginChangeEvent(player: TerixPlayer, val preOrigin: Origin, val newOrigin: Origin, val bypassCooldown: Boolean = false, val skipRequirement: Boolean = false) : KPlayerEvent

Called when a player tries to change origin.

Note: This event will be called in a cancelled state sometimes.

Parameters

player

The player that tried to change origin.

Constructors

PlayerOriginChangeEvent

fun PlayerOriginChangeEvent(player: TerixPlayer, preOrigin: Origin, newOrigin: Origin, bypassCooldown: Boolean = false, skipRequirement: Boolean = false)

Types

object Companion : CompanionEventHandler

enum Result : Enum<PlayerOriginChangeEvent.Result>

Functions

open fun callEvent(): Boolean

@NotNull

open fun getEventName(): @NotNull String

open override fun getHandlers(): HandlerList

@NotNull

fun getPlayer(): @NotNull Player

fun isAsynchronous(): Boolean

open override fun isCancelled(): Boolean

open override fun setCancelled(cancel: Boolean)

Properties

val bypassCooldown: Boolean = false

If the cooldown is bypassed.

val newOrigin: Origin

The new origin.

val preOrigin: Origin

The players current origin.

var result: PlayerOriginChangeEvent.Result

skipRequirement

val skipRequirement: Boolean = false

If the origins' requirement check is skipped.