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

Class IgnoreEvent

java.lang.Object

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

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, OfflinePlayerEvent

Direct Known Subclasses:

UnignoreEvent

public class IgnoreEvent
extends Object
implements OfflinePlayerEvent, CancellableEvent

Represents an event called before a player starts ignoring another player.

See Also:

• PlayerIgnoreManager.ignore(OfflinePlayer, OfflinePlayer)

Constructor Summary

Constructors

Constructor	Description
IgnoreEvent(OfflinePlayer player, OfflinePlayer ignoredPlayer)	Constructs a new ignore event.

Method Summary

Modifier and Type	Method	Description
OfflinePlayer	getIgnoredPlayer()	Gets the ignored player.
OfflinePlayer	getPlayer()	Gets the player involved with this event.
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

IgnoreEvent

public IgnoreEvent(OfflinePlayer player,
 OfflinePlayer ignoredPlayer)

Constructs a new ignore event.

Parameters:

player - Player involved

ignoredPlayer - Ignored player

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 OfflinePlayer getPlayer()

Description copied from interface: OfflinePlayerEvent

Gets the player involved with this event.

Specified by:

getPlayer in interface OfflinePlayerEvent

Returns:

Player involved

getIgnoredPlayer

public OfflinePlayer getIgnoredPlayer()

Gets the ignored player.

Returns:

Ignored player