Package me.remigio07.chatplugin.api.server.event.chat

Class PlayerPingEvent

java.lang.Object

me.remigio07.chatplugin.api.server.event.chat.ChatEvent

me.remigio07.chatplugin.api.server.event.chat.PlayerPingEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class PlayerPingEvent
extends ChatEvent
implements CancellableEvent

Represents an event called before a player gets pinged by another player in the chat.

See Also:

• PlayerPingManager.performPing(ChatPluginServerPlayer, String, ChatChannel, List)

Constructor Summary

Constructors

Constructor	Description
PlayerPingEvent(ChatPluginServerPlayer player, ChatPluginServerPlayer target, String message)	Constructs a new player ping event.

Method Summary

Modifier and Type	Method	Description
ChatPluginServerPlayer	getTarget()	Gets the target player of the ping specified in ChatEvent.getMessage().
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 me.remigio07.chatplugin.api.server.event.chat.ChatEvent

getMessage, getPlayer

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

PlayerPingEvent

public PlayerPingEvent(ChatPluginServerPlayer player,
 ChatPluginServerPlayer target,
 String message)

Constructs a new player ping event.

Parameters:

player - Player involved

target - Target player

message - Message involved

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

getTarget

public ChatPluginServerPlayer getTarget()

Gets the target player of the ping specified in ChatEvent.getMessage().

Returns:

Target player