io.github.nucleuspowered.nucleus.api.chat

Interface NucleusChatChannel

All Superinterfaces:

org.spongepowered.api.text.channel.MessageChannel

All Known Subinterfaces:

NucleusChatChannel.ActionMessage, NucleusChatChannel.HelpOp, NucleusChatChannel.StaffChat

public interface NucleusChatChannel
extends org.spongepowered.api.text.channel.MessageChannel

This interface holds chat channels that Nucleus uses.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusChatChannel.ActionMessage Indicates that the channel is a /me message.
static interface	NucleusChatChannel.HelpOp Indicates that the channel is a /helpop messages
static interface	NucleusChatChannel.StaffChat Indicates that the channel is Staff Chat.

Field Summary

Fields inherited from interface org.spongepowered.api.text.channel.MessageChannel

TO_ALL, TO_CONSOLE, TO_NONE, TO_PLAYERS

Method Summary

Modifier and Type	Method and Description
default org.spongepowered.api.text.Text	format(org.spongepowered.api.command.CommandSource sender, org.spongepowered.api.text.channel.MessageReceiver receiver, org.spongepowered.api.text.Text text) Returns how this channel will format a message bound for the specified MessageReceiver from the specified CommandSource sender.

Methods inherited from interface org.spongepowered.api.text.channel.MessageChannel

asMutable, combined, combined, fixed, fixed, getMembers, permission, send, send, send, send, transformMessage, world

Method Detail

format

default org.spongepowered.api.text.Text format(org.spongepowered.api.command.CommandSource sender,
                                               org.spongepowered.api.text.channel.MessageReceiver receiver,
                                               org.spongepowered.api.text.Text text)

Returns how this channel will format a message bound for the specified MessageReceiver from the specified CommandSource sender.

Parameters:

receiver - The receiver.

text - The message to format.

Returns:

The formatted text.