Package net.draycia.carbon.api.event.events

Interface CarbonPrivateChatEvent

All Superinterfaces:

Cancellable, CarbonEvent

@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
public interface CarbonPrivateChatEvent
extends CarbonEvent, Cancellable

Called whenever a player privately messages another player.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
Component	message()	The message that will be sent.
void	message(Component message)	Sets the message that will be sent.
CarbonPlayer	recipient()	The message recipient.
CarbonPlayer	sender()	The message sender.

Methods inherited from interface net.draycia.carbon.api.event.Cancellable

cancelled, cancelled

Method Details

message

void message(Component message)

Sets the message that will be sent.

Parameters:

message - the new message

Throws:

NullPointerException - if message is null

Since:

3.0.0

message

Component message()

The message that will be sent.

Returns:

the message

Since:

3.0.0

sender

CarbonPlayer sender()

The message sender.

Returns:

the sender of the message

Since:

3.0.0

recipient

CarbonPlayer recipient()

The message recipient.

Returns:

the recipient of the message

Since:

3.0.0