Package dev.hypera.chameleon.user

Interface ChatUser

All Superinterfaces:

net.kyori.adventure.audience.Audience, MetadataHolder, PermissionHolder, net.kyori.adventure.pointer.Pointered

All Known Subinterfaces:

ConsoleUser, ProxyUser, ServerUser, User

@NonExtendable
public interface ChatUser
extends net.kyori.adventure.audience.Audience, PermissionHolder, MetadataHolder

Represents something that can receive messages.

This could represent a connected Minecraft player, or the platform's console.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getName()	Get the name of this user.
boolean	hasInteractiveChat()	Get whether this user can interact with chat messages.

Methods inherited from interface net.kyori.adventure.audience.Audience

clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, showTitle, stopSound, stopSound

Methods inherited from interface dev.hypera.chameleon.meta.MetadataHolder

getMetadata, removeMetadata, setDynamicMetadata, setMetadata

Methods inherited from interface dev.hypera.chameleon.user.PermissionHolder

hasPermission

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Method Detail

getName

@NotNull
@NotNull String getName()

Get the name of this user.

Returns:

user's name.

hasInteractiveChat

boolean hasInteractiveChat()

Get whether this user can interact with chat messages.

An example usage of this would be checking if a user can click on a chat message, and if so use a click event for a link, otherwise just display the link.

Returns:

true if this user can interact with chat, otherwise false.