Package ovh.mythmc.social.api.chat.channel

Class SimpleChatChannel

java.lang.Object

ovh.mythmc.social.api.chat.channel.SimpleChatChannel

All Implemented Interfaces:

ChatChannel

Direct Known Subclasses:

GroupChatChannel

public class SimpleChatChannel
extends Object

Nested Class Summary

Nested classes/interfaces inherited from interface ovh.mythmc.social.api.chat.channel.ChatChannel

ChatChannel.ChannelType

Field Summary

Fields

Modifier and Type	Field	Description
protected final LinkedHashSet<UUID>	memberUuids

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleChatChannel(@NotNull String name, @Nullable String alias, @NotNull TextColor color, @NotNull Iterable<String> commands, @NotNull Component icon, boolean showHoverText, @NotNull Component hoverText, @NotNull TextColor nicknameColor, @NotNull String textDivider, @Nullable String permission, @Nullable TextColor textColor, boolean joinByDefault)

Method Summary

Modifier and Type	Method	Description
boolean	addMember(@NotNull UUID uuid)	Adds the player with the given UUID to this channel.
@NotNull Mutable<String>	alias()	Returns the mutable alias for this channel, if any.
@NotNull TextColor	color()	Returns the primary colour associated with this channel.
@NotNull Iterable<String>	commands()	Returns the slash commands that switch a player into this channel.
@NotNull Component	description()	Returns a short description of this channel shown in menus.
protected ChatFormatBuilder	formatBuilder()
static SimpleChatChannel	fromConfigField(ChatSettings.Channel channelField)
@NotNull Component	icon()	Returns the icon component shown in menus for this channel.
boolean	isMember(@NotNull UUID uuid)	Returns true if the player with the given UUID is a member of this channel.
boolean	joinByDefault()	Returns true if players are automatically added to this channel on join.
@NotNull List<SocialUser>	members()	Returns all users currently in this channel.
@NotNull String	name()	Returns the unique name that identifies this channel.
@NotNull Optional<String>	permission()	Returns the permission node required to see or write in this channel, if any.
@NotNull Component	prefix(@NotNull SocialUser user, @NotNull SocialRegisteredMessageContext message, @NotNull SocialParserContext parser)	Builds the rendered prefix shown before each message in this channel.
boolean	removeMember(@NotNull UUID uuid)	Removes the player with the given UUID from this channel.
@NotNull Iterable<ChatRendererFeature>	supportedRendererFeatures()	Returns the renderer features that are active in this channel (e.g. replies, reactions).
@NotNull Optional<TextColor>	textColor()	Returns an optional override colour applied to message text in this channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ovh.mythmc.social.api.chat.channel.ChatChannel

addMember, aliasOrName, isMember, removeMember

Field Details

memberUuids

protected final LinkedHashSet<UUID> memberUuids

Constructor Details

SimpleChatChannel

protected SimpleChatChannel(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable String alias,
 @NotNull
 @NotNull TextColor color,
 @NotNull
 @NotNull Iterable<String> commands,
 @NotNull
 @NotNull Component icon,
 boolean showHoverText,
 @NotNull
 @NotNull Component hoverText,
 @NotNull
 @NotNull TextColor nicknameColor,
 @NotNull
 @NotNull String textDivider,
 @Nullable
 @Nullable String permission,
 @Nullable
 @Nullable TextColor textColor,
 boolean joinByDefault)

Method Details

formatBuilder

protected ChatFormatBuilder formatBuilder()

fromConfigField

public static SimpleChatChannel fromConfigField(@NotNull
 ChatSettings.Channel channelField)

name

@NotNull
public @NotNull String name()

Description copied from interface: ChatChannel

Returns the unique name that identifies this channel.

Specified by:

name in interface ChatChannel

alias

@NotNull
public @NotNull Mutable<String> alias()

Description copied from interface: ChatChannel

Returns the mutable alias for this channel, if any.

Specified by:

alias in interface ChatChannel

commands

@NotNull
public @NotNull Iterable<String> commands()

Description copied from interface: ChatChannel

Returns the slash commands that switch a player into this channel.

Specified by:

commands in interface ChatChannel

icon

@NotNull
public @NotNull Component icon()

Description copied from interface: ChatChannel

Returns the icon component shown in menus for this channel.

Specified by:

icon in interface ChatChannel

description

@NotNull
public @NotNull Component description()

Description copied from interface: ChatChannel

Returns a short description of this channel shown in menus.

Specified by:

description in interface ChatChannel

color

@NotNull
public @NotNull TextColor color()

Description copied from interface: ChatChannel

Returns the primary colour associated with this channel.

Specified by:

color in interface ChatChannel

permission

@NotNull
public @NotNull Optional<String> permission()

Description copied from interface: ChatChannel

Returns the permission node required to see or write in this channel, if any.

Specified by:

permission in interface ChatChannel

textColor

@NotNull
public @NotNull Optional<TextColor> textColor()

Description copied from interface: ChatChannel

Returns an optional override colour applied to message text in this channel.

Specified by:

textColor in interface ChatChannel

joinByDefault

public boolean joinByDefault()

Description copied from interface: ChatChannel

Returns true if players are automatically added to this channel on join.

Specified by:

joinByDefault in interface ChatChannel

supportedRendererFeatures

@NotNull
public @NotNull Iterable<ChatRendererFeature> supportedRendererFeatures()

Description copied from interface: ChatChannel

Returns the renderer features that are active in this channel (e.g. replies, reactions).

Specified by:

supportedRendererFeatures in interface ChatChannel

prefix

@NotNull
public @NotNull Component prefix(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull SocialRegisteredMessageContext message,
 @NotNull
 @NotNull SocialParserContext parser)

Description copied from interface: ChatChannel

Builds the rendered prefix shown before each message in this channel.

Specified by:

prefix in interface ChatChannel

Parameters:

user - the message sender

message - the registered message context

parser - the parser context used for placeholder resolution

Returns:

the rendered prefix component

addMember

public boolean addMember(@NotNull
 @NotNull UUID uuid)

Description copied from interface: ChatChannel

Adds the player with the given UUID to this channel.

Specified by:

addMember in interface ChatChannel

Parameters:

uuid - the player's UUID

Returns:

true if the player was not already a member

removeMember

public boolean removeMember(@NotNull
 @NotNull UUID uuid)

Description copied from interface: ChatChannel

Removes the player with the given UUID from this channel.

Specified by:

removeMember in interface ChatChannel

Parameters:

uuid - the player's UUID

Returns:

true if the player was a member

members

@NotNull
public @NotNull List<SocialUser> members()

Description copied from interface: ChatChannel

Returns all users currently in this channel.

Specified by:

members in interface ChatChannel

Returns:

the current members

isMember

public boolean isMember(@NotNull
 @NotNull UUID uuid)

Description copied from interface: ChatChannel

Returns true if the player with the given UUID is a member of this channel.

Specified by:

isMember in interface ChatChannel

Parameters:

uuid - the player UUID to check

Returns:

true if the player is a member