Package me.remigio07.chatplugin.api.server.event.punishment.kick

Class FakeKickEvent

java.lang.Object

me.remigio07.chatplugin.api.server.event.punishment.kick.FakeKickEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class FakeKickEvent
extends Object
implements CancellableEvent, ChatPluginServerPlayerEvent

Represents the event called after a fake kick gets processed.

Constructor Summary

Constructors

Constructor	Description
FakeKickEvent(ChatPluginServerPlayer player, String reason, KickType type)	Constructs a new fake kick event.

Method Summary

Modifier and Type	Method	Description
ChatPluginServerPlayer	getPlayer()	Gets the player involved with this event.
String	getReason()	Gets the fake kick's reason.
KickType	getType()	Gets the fake kick's type.
boolean	isCancelled()	Checks if this event has been cancelled and will not be executed.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

call

Constructor Details

FakeKickEvent

public FakeKickEvent(ChatPluginServerPlayer player,
 String reason,
 KickType type)

Constructs a new fake kick event.

Parameters:

player - Player involved

reason - Fake kick's reason

type - Fake kick's type

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled and will not be executed.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Whether this event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - Whether this event should be cancelled

getPlayer

public ChatPluginServerPlayer getPlayer()

Description copied from interface: ChatPluginServerPlayerEvent

Gets the player involved with this event.

Specified by:

getPlayer in interface ChatPluginPlayerEvent

Specified by:

getPlayer in interface ChatPluginServerPlayerEvent

Returns:

Player involved

getReason

public String getReason()

Gets the fake kick's reason.

Returns:

Kick's reason

getType

public KickType getType()

Gets the fake kick's type.

Returns:

Kick's type