io.github.nucleuspowered.nucleus.api.util

Interface CancelMessageEvent

All Superinterfaces:

org.spongepowered.api.event.Cancellable

All Known Subinterfaces:

NucleusHomeEvent, NucleusHomeEvent.Create, NucleusHomeEvent.Delete, NucleusHomeEvent.Modify, NucleusHomeEvent.Use, NucleusKitEvent.Redeem.Pre, NucleusTeleportEvent, NucleusTeleportEvent.AboutToTeleport, NucleusTeleportEvent.Request, NucleusTeleportEvent.Request.CauseToPlayer, NucleusTeleportEvent.Request.PlayerToCause, NucleusWarpEvent, NucleusWarpEvent.Create, NucleusWarpEvent.Delete, NucleusWarpEvent.Use

public interface CancelMessageEvent
extends org.spongepowered.api.event.Cancellable

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.text.Text>	getCancelMessage() The message to send to the player if the event is cancelled, if any.
void	setCancelMessage(org.spongepowered.api.text.Text message) The message to display to the user if the event is cancelled, or null to clear.

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

isCancelled, setCancelled

Method Detail

getCancelMessage

java.util.Optional<org.spongepowered.api.text.Text> getCancelMessage()

The message to send to the player if the event is cancelled, if any.

Returns:

The message.

setCancelMessage

void setCancelMessage(@Nullable
                      org.spongepowered.api.text.Text message)

The message to display to the user if the event is cancelled, or null to clear.

Parameters:

message - The message.