Package ovh.mythmc.social.api.bukkit

Class BukkitSocialUser

java.lang.Object

ovh.mythmc.social.api.user.AbstractSocialUser

ovh.mythmc.social.api.bukkit.BukkitSocialUser

All Implemented Interfaces:

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

public class BukkitSocialUser
extends AbstractSocialUser
implements InGameSocialUser

The SocialUser implementation for the Bukkit platform.

Nested Class Summary

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

ForwardingAudience.Single

Field Summary

Fields inherited from class ovh.mythmc.social.api.user.AbstractSocialUser

blockedChannelNames, companion, displayName, lastMessageTimestamp, lastPrivateMessageRecipient, mainChannel, rendererClass, socialSpy, username, uuid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BukkitSocialUser(@NotNull Player player)

Method Summary

Modifier and Type	Method	Description
@NotNull Audience	audience()
boolean	checkPermission(@NotNull String permission)	Checks if this SocialUser has a specific permission node.
static BukkitSocialUser	from(@NotNull UUID uuid)	Gets the BukkitSocialUser instance for a specific UUID.
static BukkitSocialUser	from(@NotNull Player player)	Gets the BukkitSocialUser instance for a specific Player.
static BukkitSocialUser	from(@NotNull SocialUser user)	Gets the BukkitSocialUser instance for a specific SocialUser.
boolean	isOnline()	Determines whether the entity is currently online.
@NotNull OfflinePlayer	offlinePlayer()	Gets the OfflinePlayer instance of the user.
@NotNull Optional<Player>	player()	Gets the optional Player instance of the user.
<T extends NetworkPayloadWrapper.ServerToClient> void	sendCustomPayload(@NotNull S2CNetworkChannelWrapper<T> channel, T payload)	Sends a custom payload to this user.

Methods inherited from class ovh.mythmc.social.api.user.AbstractSocialUser

blockedChannels, companion, displayName, groupChannel, isExpired, lastMessageTimestamp, lastPrivateMessageRecipient, mainChannel, playReaction, rendererClass, socialSpy, username, uuid

Methods inherited from class java.lang.Object

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

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

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

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

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

playReaction

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

displayNameOrUsername, rendererClass, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage, sendParsableMessage

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

displayName, lastMessageTimestamp, socialSpy

Constructor Details

BukkitSocialUser

protected BukkitSocialUser(@NotNull
 @NotNull Player player)

Method Details

from

public static BukkitSocialUser from(@NotNull
 @NotNull Player player)

Gets the BukkitSocialUser instance for a specific Player.

Parameters:

player - the Player to get the BukkitSocialUser instance from

Returns:

the BukkitSocialUser instance matching the Player

from

public static BukkitSocialUser from(@NotNull
 @NotNull SocialUser user)

Gets the BukkitSocialUser instance for a specific SocialUser.

Parameters:

user - the SocialUser to get the BukkitSocialUser from

Returns:

the BukkitSocialUser instance matching the SocialUser

from

public static BukkitSocialUser from(@NotNull
 @NotNull UUID uuid)

Gets the BukkitSocialUser instance for a specific UUID.

Parameters:

uuid - the UUID to get the BukkitSocialUser from

Returns:

the BukkitSocialUser instance matching the UUID

checkPermission

public boolean checkPermission(@NotNull
 @NotNull String permission)

Description copied from interface: SocialUser

Checks if this SocialUser has a specific permission node.

Specified by:

checkPermission in interface SocialUser

Parameters:

permission - the permission node to check

Returns:

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

sendCustomPayload

public <T extends NetworkPayloadWrapper.ServerToClient>
void sendCustomPayload(@NotNull
 @NotNull S2CNetworkChannelWrapper<T> channel,
 @NotNull
 T payload)

Description copied from interface: CompanionClient

Sends a custom payload to this user.

Specified by:

sendCustomPayload in interface CompanionClient

Type Parameters:

T - the NetworkPayloadWrapper.ServerToClient implementation to send

Parameters:

channel - the S2CNetworkChannelWrapper where the payload should be sent

payload - the payload that should be sent

isOnline

public boolean isOnline()

Description copied from interface: OnlinePresence

Determines whether the entity is currently online.

Specified by:

isOnline in interface OnlinePresence

Returns:

true if the entity is online, false otherwise

audience

@NotNull
public @NotNull Audience audience()

Specified by:

audience in interface ForwardingAudience.Single

offlinePlayer

@NotNull
public @NotNull OfflinePlayer offlinePlayer()

Gets the OfflinePlayer instance of the user.

Returns:

the OfflinePlayer instance of this user

player

@NotNull
public @NotNull Optional<Player> player()

Gets the optional Player instance of the user.

Returns:

an Optional containing the Player instance if available, or an empty Optional otherwise