Package dev.hypera.chameleon.event.server

Class ServerUserKickEvent

java.lang.Object

dev.hypera.chameleon.event.server.ServerUserKickEvent

All Implemented Interfaces:

ChameleonEvent, UserEvent, ServerEvent, ServerUserEvent

public final class ServerUserKickEvent
extends Object
implements ServerUserEvent

Server user kick event, dispatched when a user is kicked from the server.

Constructor Summary

Constructors

Constructor	Description
ServerUserKickEvent(@NotNull ServerUser user, @Nullable net.kyori.adventure.text.Component reason)	Server user kick event constructor.

Method Summary

Modifier and Type	Method	Description
@NotNull net.kyori.adventure.text.Component	getReason()	Get the reason for this disconnection.
@NotNull ServerUser	getUser()	Get the server user who was kicked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerUserKickEvent

@Internal
public ServerUserKickEvent(@NotNull
                           @NotNull ServerUser user,
                           @Nullable
                           @Nullable net.kyori.adventure.text.Component reason)

Server user kick event constructor.

Parameters:

user - The server user who was kicked.

reason - The reason for the user being kicked.

Method Detail

getUser

@NotNull
public @NotNull ServerUser getUser()

Get the server user who was kicked.

Specified by:

getUser in interface ServerUserEvent

Specified by:

getUser in interface UserEvent

Returns:

the server user who was kicked.

getReason

@NotNull
public @NotNull net.kyori.adventure.text.Component getReason()

Get the reason for this disconnection.

Returns:

disconnect reason, defaults to Disconnected.