com.planet_ink.coffee_mud.Libraries.interfaces
Interface ChannelsLibrary.CMChannel

Enclosing interface:

ChannelsLibrary

public static interface ChannelsLibrary.CMChannel

Basic Channel definition

Method Summary

java.lang.String	colorOverrideANSICodes() Empty string, or a color ansi codes to override the default channel color
java.lang.String	colorOverrideWords() Empty string, or a color code words to override the default channel color
java.util.Set<ChannelsLibrary.ChannelFlag>	flags() The channel flags for this channel.
java.lang.String	i3name() An empty string, or the name of the I3 channel that this channel is mapped to.
java.lang.String	imc2Name() An empty string, or the name of the IMC2 channel that this channel is mapped to.
java.lang.String	mask() The zapper mask to filter in those who may read this channel.
java.lang.String	name() The name of the channel, always uppercased
SLinkedList<ChannelsLibrary.ChannelMsg>	queue() The internal cached queue of previous channel messages.

Method Detail

name

java.lang.String name()

The name of the channel, always uppercased

Returns:

name of the channel

i3name

java.lang.String i3name()

An empty string, or the name of the I3 channel that this channel is mapped to.

Returns:

the name of the I3 channel or ""

imc2Name

java.lang.String imc2Name()

An empty string, or the name of the IMC2 channel that this channel is mapped to.

Returns:

the name of the IMC2 channel or ""

mask

java.lang.String mask()

The zapper mask to filter in those who may read this channel.

Returns:

the zapper mask for who may read

See Also:

MaskingLibrary

colorOverrideANSICodes

java.lang.String colorOverrideANSICodes()

Empty string, or a color ansi codes to override the default channel color

Returns:

Empty string, or a color ansi codes to override

See Also:

ColorLibrary

colorOverrideWords

java.lang.String colorOverrideWords()

Empty string, or a color code words to override the default channel color

Returns:

Empty string, or a color code words to override

See Also:

ColorLibrary

flags

java.util.Set<ChannelsLibrary.ChannelFlag> flags()

The channel flags for this channel.

Returns:

channel flags for this channel.

See Also:

ChannelsLibrary.ChannelFlag

queue

SLinkedList<ChannelsLibrary.ChannelMsg> queue()

The internal cached queue of previous channel messages.

Returns:

internal cached queue of messages

See Also:

Always trimmed when it gets too large/