PlayerJoinEvent

Called when a player logs in and a player object has been constructed for them.

Types

Link copied to clipboard
data class Result(val message: Component?, val hasJoinedBefore: Boolean) : Record

The result of a join event.

Functions

Link copied to clipboard
abstract fun allow()

Allows this event to occur.

Link copied to clipboard

Allows this event to occur, and sets the result to the given result.

Link copied to clipboard
abstract fun deny()

Denies an event from occurring.

Link copied to clipboard

Denies this event from occur, and sets the result to the given result.

Link copied to clipboard
abstract fun isAllowed(): Boolean

Checks if this event is allowed to happen.

Properties

Link copied to clipboard
@get:JvmName(name = "hasJoinedBefore")
abstract val hasJoinedBefore: Boolean

If the player has joined the server before.

Link copied to clipboard
abstract val player: Player

The player involved in this event.

Link copied to clipboard

The result that is returned by this event.