io.github.nucleuspowered.nucleus.api.module.afk.event

Interface NucleusAFKEvent.NotifyCommand

All Superinterfaces:

org.spongepowered.api.event.Event, org.spongepowered.api.event.entity.TargetEntityEvent, org.spongepowered.api.event.entity.living.humanoid.TargetHumanoidEvent, org.spongepowered.api.event.entity.living.TargetLivingEvent, org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Enclosing interface:

NucleusAFKEvent

@MightOccurAsync
public static interface NucleusAFKEvent.NotifyCommand
extends org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Fired when the target of a command is AFK and the command is marked as one that should notify the sender.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.text.Text>	getMessage() Gets the message to send to the command invoker
java.util.Optional<org.spongepowered.api.text.Text>	getOriginalMessage() Gets the original message that would have been sent to players, if any.
void	setMessage(org.spongepowered.api.text.Text message) Sets the message to send to the command invoker, if any.

Methods inherited from interface org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

getTargetEntity

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

getCause, getContext, getSource

Method Detail

getOriginalMessage

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

Gets the original message that would have been sent to players, if any.

Returns:

The message, if any

getMessage

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

Gets the message to send to the command invoker

Returns:

The message, if any.

setMessage

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

Sets the message to send to the command invoker, if any.

Parameters:

message - The message. A null message suppresses the message.