org.spongepowered.api.event.entity.living.humanoid.player

Interface KickPlayerEvent

All Superinterfaces:

Event, MessageChannelEvent, MessageEvent, TargetEntityEvent, TargetHumanoidEvent, TargetLivingEvent, TargetPlayerEvent

public interface KickPlayerEvent
extends TargetPlayerEvent, MessageChannelEvent

Fired when a Player is kicked.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.message.MessageChannelEvent

MessageChannelEvent.Chat

Nested classes/interfaces inherited from interface org.spongepowered.api.event.message.MessageEvent

MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, MessageEvent.MessageFormatter

Field Summary

Fields inherited from interface org.spongepowered.api.event.message.MessageEvent

PARAM_MESSAGE_BODY, PARAM_MESSAGE_FOOTER, PARAM_MESSAGE_HEADER

Method Summary

Modifier and Type	Method and Description
Optional<MessageChannel>	getChannel() Deprecated. Not used in this event.
MessageChannel	getOriginalChannel() Deprecated. Not used in this event.
void	setChannel(MessageChannel channel) Deprecated. Not used in this event.
void	setMessageCancelled(boolean cancelled) Deprecated.

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

getTargetEntity

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.message.MessageEvent

clearMessage, getFormatter, getMessage, getOriginalMessage, isMessageCancelled, setMessage, setMessage, setMessage

Method Detail

getOriginalChannel

@Deprecated
MessageChannel getOriginalChannel()

Deprecated. Not used in this event.

Ignored.

Specified by:

getOriginalChannel in interface MessageChannelEvent

Returns:

A MessageChannel

getChannel

@Deprecated
Optional<MessageChannel> getChannel()

Deprecated. Not used in this event.

Ignored.

Specified by:

getChannel in interface MessageChannelEvent

Returns:

A MessageChannel

setChannel

@Deprecated
void setChannel(@Nullable
                             MessageChannel channel)

Deprecated. Not used in this event.

Ignored.

Specified by:

setChannel in interface MessageChannelEvent

Parameters:

channel - A MessageChannel that is not used in this event.

setMessageCancelled

@Deprecated
void setMessageCancelled(boolean cancelled)

Deprecated.

Ignored.

Specified by:

setMessageCancelled in interface MessageEvent

Parameters:

cancelled - True if should not be sent