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

Interface NucleusAFKEvent

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

All Known Subinterfaces:

NucleusAFKEvent.GoingAFK, NucleusAFKEvent.Kick, NucleusAFKEvent.ReturningFromAFK

public interface NucleusAFKEvent
extends org.spongepowered.api.event.entity.living.humanoid.player.TargetPlayerEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusAFKEvent.GoingAFK Fired when a player goes AFK.
static interface	NucleusAFKEvent.Kick Fired when a player is about to be kicked due to inactivity.
static interface	NucleusAFKEvent.NotifyCommand Fired when the target of a command is AFK and the command is marked as one that should notify the sender.
static interface	NucleusAFKEvent.ReturningFromAFK Fired when a player returns from AFK.

Method Summary

Modifier and Type	Method and Description
org.spongepowered.api.text.channel.MessageChannel	getChannel() Gets the channel to send the message to
java.util.Optional<org.spongepowered.api.text.Text>	getMessage() Gets the message to send to players
org.spongepowered.api.text.channel.MessageChannel	getOriginalChannel() Gets the original message channel to send the message to
java.util.Optional<org.spongepowered.api.text.Text>	getOriginalMessage() Gets the original message that would have been sent to players, if any.
void	setChannel(org.spongepowered.api.text.channel.MessageChannel channel) Sets the message channel to send the message to
void	setMessage(org.spongepowered.api.text.Text message) Sets the message to send to players, 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 players

Returns:

The message, if any.

setMessage

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

Sets the message to send to players, if any.

Parameters:

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

getOriginalChannel

org.spongepowered.api.text.channel.MessageChannel getOriginalChannel()

Gets the original message channel to send the message to

Returns:

The MessageChannel

getChannel

org.spongepowered.api.text.channel.MessageChannel getChannel()

Gets the channel to send the message to

Returns:

The MessageChannel

setChannel

void setChannel(org.spongepowered.api.text.channel.MessageChannel channel)

Sets the message channel to send the message to

Parameters:

channel - The MessageChannel