Class ServerMessageEvent

java.lang.Object

me.internalizable.numdrassl.api.event.server.ServerMessageEvent

All Implemented Interfaces:

Cancellable

public class ServerMessageEvent
extends Object
implements Cancellable

Event fired when the server sends a chat/system message to a player. This event is fired BEFORE the message is delivered to the client.

This event is cancellable. If cancelled, the message will not be shown to the player.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServerMessageEvent.MessageType	Type of server message.

Constructor Summary

Constructors

Constructor	Description
ServerMessageEvent(Player player, ServerMessageEvent.MessageType type, String message)

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Get the message content.
Player	getPlayer()	Get the player receiving the message.
ServerMessageEvent.MessageType	getType()	Get the type of message.
boolean	isCancelled()	Check if this event has been cancelled.
void	setCancelled(boolean cancelled)	Set whether this event is cancelled.
void	setMessage(String message)	Set the message content.

Methods inherited from class Object

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

Constructor Details

ServerMessageEvent

public ServerMessageEvent(@Nonnull
 Player player,
 @Nonnull
 ServerMessageEvent.MessageType type,
 @Nullable
 String message)

Method Details

getPlayer

@Nonnull
public Player getPlayer()

Get the player receiving the message.

Returns:

the player

getType

@Nonnull
public ServerMessageEvent.MessageType getType()

Get the type of message.

Returns:

the message type

getMessage

@Nonnull
public String getMessage()

Get the message content.

Returns:

the message

setMessage

public void setMessage(@Nonnull
 String message)

Set the message content.

Parameters:

message - the new message

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Check if this event has been cancelled.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: Cancellable

Set whether this event is cancelled.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancelled - true to cancel the event