io.github.nucleuspowered.nucleus.api.chat

Interface NucleusNoFormatChannel

All Superinterfaces:

org.spongepowered.api.text.channel.MessageChannel

All Known Subinterfaces:

NucleusChatChannel.ActionMessage, NucleusChatChannel.HelpOp, NucleusChatChannel.StaffChat

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

This interface is a marker to indicate to the Chat module that messages through this channel might not be formatted.

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 boolean	formatMessages() Determines whether Nucleus should try to format the message.
default boolean	removePrefix() Determines whether Nucleus should remove the prefix from the message.

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

formatMessages

default boolean formatMessages()

Determines whether Nucleus should try to format the message.

Returns:

true if it should, false otherwise (the default)

removePrefix

default boolean removePrefix()

Determines whether Nucleus should remove the prefix from the message. Ignored if formatMessages() is true.

Returns:

true if it should (the default), false otherwise.