io.github.nucleuspowered.nucleus.api.module.staffchat

Interface NucleusStaffChatService

public interface NucleusStaffChatService

Provides a way to get the Staff Chat message channel instance.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<org.spongepowered.api.text.channel.MessageReceiver>	getStaffChannelMembers() Gets the memebers of the Staff Chat channel.
boolean	isCurrentlyChattingInStaffChat(org.spongepowered.api.command.CommandSource source) Gets if the given CommandSource is currently talking in staff chat.
boolean	isCurrentlyChattingInStaffChat(java.util.UUID uuid) Gets if a player with the given UUID is currently talking in staff chat.
boolean	isDirectedToStaffChat(org.spongepowered.api.event.message.MessageChannelEvent.Chat event) Gets if the provided MessageChannelEvent.Chat is going to be sent to the staff chat channel.
void	sendMessageFrom(org.spongepowered.api.command.CommandSource source, org.spongepowered.api.text.Text message) Sends a message to the Staff Chat channel.

Method Detail

isDirectedToStaffChat

boolean isDirectedToStaffChat(org.spongepowered.api.event.message.MessageChannelEvent.Chat event)

Gets if the provided MessageChannelEvent.Chat is going to be sent to the staff chat channel.

Parameters:

event - The MessageChannelEvent.Chat

Returns:

true if so

isCurrentlyChattingInStaffChat

boolean isCurrentlyChattingInStaffChat(org.spongepowered.api.command.CommandSource source)

Gets if the given CommandSource is currently talking in staff chat.

Parameters:

source - The CommandSource

Returns:

true if so

isCurrentlyChattingInStaffChat

boolean isCurrentlyChattingInStaffChat(java.util.UUID uuid)

Gets if a player with the given UUID is currently talking in staff chat.

Parameters:

uuid - The UUID of the User

Returns:

true if so

getStaffChannelMembers

java.util.Collection<org.spongepowered.api.text.channel.MessageReceiver> getStaffChannelMembers()

Gets the memebers of the Staff Chat channel.

Returns:

The CommandSources who are members of the channel.

sendMessageFrom

void sendMessageFrom(org.spongepowered.api.command.CommandSource source,
                     org.spongepowered.api.text.Text message)

Sends a message to the Staff Chat channel.

Parameters:

source - The CommandSource that is sending this message.

message - The message to send.