Package ovh.mythmc.social.api.user

Interface SocialUser

All Superinterfaces:

Audience, ChatParticipant, CompanionClient, ForwardingAudience, ForwardingAudience.Single, Identified, OnlinePresence, Pointered, Reactable, UserPreferences

All Known Subinterfaces:

InGameSocialUser

All Known Implementing Classes:

AbstractSocialUser, BukkitSocialUser, ConsoleSocialUser

public interface SocialUser
extends ChatParticipant, Identified, CompanionClient, OnlinePresence, Reactable, UserPreferences, ForwardingAudience.Single

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

ForwardingAudience.Single

Method Summary

Modifier and Type	Method	Description
boolean	checkPermission(@NotNull String permission)	Checks if this SocialUser has a specific permission node.
default @NotNull TextComponent	displayNameOrUsername()	Gets the display name of this SocialUser if present, or its username otherwise.
Class<? extends SocialUser>	rendererClass()	Gets the Class that SocialChatRenderer will use as a reference to render messages.
default void	sendParsableMessage(@NotNull String message)	Parses and sends a given message to this SocialUser.
default void	sendParsableMessage(@NotNull String message, boolean playerInput)	Parses and sends a given message to this SocialUser.
default void	sendParsableMessage(@NotNull Component component)	Parses and sends a given message to this SocialUser.
default void	sendParsableMessage(@NotNull Component component, boolean playerInput)	Parses and sends a given message to this SocialUser.
default void	sendParsableMessage(@NotNull SocialParserContext context)	Parses and sends a given message to this SocialUser.
default void	sendParsableMessage(@NotNull SocialParserContext context, boolean playerInput)	Parses and sends a given message to this SocialUser.

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

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface ovh.mythmc.social.api.chat.ChatParticipant

blockedChannels, groupChannel, lastPrivateMessageRecipient, mainChannel

Methods inherited from interface ovh.mythmc.social.api.network.CompanionClient

companion, sendCustomPayload

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience.Single

audience, audiences, clearResourcePacks, clearTitle, deleteMessage, filterAudience, forEachAudience, get, getOrDefault, getOrDefaultFrom, hideBossBar, openBook, playSound, playSound, playSound, pointers, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendTitlePart, showBossBar, stopSound

Methods inherited from interface ovh.mythmc.social.api.identity.Identified

username, uuid

Methods inherited from interface ovh.mythmc.social.api.presence.OnlinePresence

isExpired, isOnline

Methods inherited from interface ovh.mythmc.social.api.reaction.Reactable

playReaction

Methods inherited from interface ovh.mythmc.social.api.user.UserPreferences

displayName, lastMessageTimestamp, socialSpy

Method Details

rendererClass

Class<? extends SocialUser> rendererClass()

Gets the Class that SocialChatRenderer will use as a reference to render messages.

Returns:

the Class subtype of SocialUser to use as a reference for the renderer

checkPermission

boolean checkPermission(@NotNull
 @NotNull String permission)

Checks if this SocialUser has a specific permission node.

Parameters:

permission - the permission node to check

Returns:

true if the user has the specific permission node, false otherwise

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull SocialParserContext context,
 boolean playerInput)

Parses and sends a given message to this SocialUser.

Parameters:

context - the SocialParserContext to parse

playerInput - whether the text processor should use the player input mode

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull SocialParserContext context)

Parses and sends a given message to this SocialUser.

Parameters:

context - the SocialParserContext to parse

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull Component component,
 boolean playerInput)

Parses and sends a given message to this SocialUser.

This method builds a SocialParserContext with the provided Component.

Parameters:

component - the Component to parse

playerInput - whether the text processor should use the player input mode

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull Component component)

Parses and sends a given message to this SocialUser.

This method builds a SocialParserContext with the provided Component.

Parameters:

component - the Component to parse

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull String message,
 boolean playerInput)

Parses and sends a given message to this SocialUser.

This method builds a SocialParserContext with the provided String wrapped in a Component.

Parameters:

message - the message to parse

playerInput - whether the text processor should use the player input mode

sendParsableMessage

default void sendParsableMessage(@NotNull
 @NotNull String message)

Parses and sends a given message to this SocialUser.

This method builds a SocialParserContext with the provided String wrapped in a Component.

Parameters:

message - the message to parse

displayNameOrUsername

@NotNull
default @NotNull TextComponent displayNameOrUsername()

Gets the display name of this SocialUser if present, or its username otherwise.

Returns:

a TextComponent with the display name of this user if present or its username otherwise