Package com.cryptomorin.xseries.profiles.objects

Interface Profileable

All Known Subinterfaces:

DelegateProfileable

All Known Implementing Classes:

CacheableProfileable, Profileable.GameProfileProfileable, Profileable.PlayerProfileable, Profileable.StringProfileable, Profileable.UsernameProfileable, Profileable.UUIDProfileable, ProfileContainer, ProfileContainer.BlockProfileContainer, ProfileContainer.BlockStateProfileContainer, ProfileContainer.ItemMetaProfileContainer, ProfileContainer.ItemStackProfileContainer, ProfileInstruction, TimedCacheableProfileable, TransformableProfile

public interface Profileable

Represents any object that has a GameProfile or one can be created with it. These objects are cached.

A GameProfile is an object that represents information about a Minecraft player's account in general (not specific to this or any other server) The most important information contained within this profile however, is the skin texture URL which the client needs to properly see the texture on items/blocks.

See Also:

• CacheableProfileable
• TimedCacheableProfileable
• TransformableProfile

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Profileable.GameProfileProfileable
static final class	Profileable.PlayerProfileable	Do we need to support PlayerProfile for hybrid server software like Geyser or Mohist that might have their own caching system?
static final class	Profileable.StringProfileable
static final class	Profileable.UsernameProfileable
static final class	Profileable.UUIDProfileable

Method Summary

Modifier and Type	Method	Description
static @NotNull Profileable	detect(@NotNull String input)	Sets the skull texture based on a string.
default @Nullable com.mojang.authlib.GameProfile	getDisposableProfile()	Same as getProfile(), except some implementations of Profileable cannot inherently return any original instance as they're not cacheable, so this method ensures that no duplicate cloning of GameProfile occurs for performance.
@Nullable @Unmodifiable com.mojang.authlib.GameProfile	getProfile()	This method should not be used directly unless you know what you're doing.
default @Nullable String	getProfileValue()	A string representation of the getProfile() which is useful for data storage which can be serialized back using detect(String).
static @NotNull Profileable	of(@NotNull ProfileInputType type, @NotNull String input)	Sets the skull texture based on a string with a known type.
static @NotNull Profileable	of(@NotNull com.mojang.authlib.GameProfile profile)	Sets the skull texture based on the specified profile.
static @NotNull Profileable	of(@NotNull UUID uuid)	Sets the skull texture based on the specified player UUID (whether it's an offline or online UUID).
static @NotNull Profileable	of(@NotNull org.bukkit.OfflinePlayer offlinePlayer)	Sets the skull texture based on the specified offline player.
static @NotNull Profileable	of(@NotNull org.bukkit.block.Block block)
static @NotNull Profileable	of(@NotNull org.bukkit.block.BlockState blockState)
static @NotNull Profileable	of(@NotNull org.bukkit.inventory.ItemStack item)
static @NotNull Profileable	of(@NotNull org.bukkit.inventory.meta.ItemMeta meta)
static <C extends Collection<Profileable>> @NotNull CompletableFuture<C>	prepare(C profileables)
static <C extends Collection<Profileable>> @NotNull CompletableFuture<C>	prepare(C profileables, @Nullable ProfileRequestConfiguration config, @Nullable com.google.common.base.Function<Throwable,Boolean> errorHandler)
default @Nullable ProfileException	test()	Tests whether this profile has any issues or throws any exception.
default @NotNull Profileable	transform(@NotNull ProfileTransformer... transformers)	Adds transformer (read ProfileTransformer) information to a copied version of this profile (so it doesn't affect this instance, but the class type will change).
static @NotNull Profileable	username(@NotNull String username)	Sets the skull texture based on the specified player UUID (whether it's an offline or online UUID).

Method Details

getProfile

@Nullable
@Internal
@Nullable @Unmodifiable com.mojang.authlib.GameProfile getProfile()

This method should not be used directly unless you know what you're doing.

The texture which might be cached. If any errors occur, the check may be re-evaluated. The cached values might also be re-evaluated due to expiration.

Returns:

the original profile (not cloned if possible) for an instance that's always guaranteed to be a copy you can use getDisposableProfile() instead. Null if no profile is set (only happens for ProfileContainer).

Throws:

ProfileException - may also throw other internal exceptions (most likely bugs)

test

@Nullable
default @Nullable ProfileException test()

Tests whether this profile has any issues or throws any exception. This is a good way if you're going to be checking for user issues before trying to ProfileInstruction.apply() them. For now, this is basically equivalent to calling getProfile() and catching exceptions. Which means that the profile will be cached if a cache is behind this profile.

These issues include, wrong username, network issues, etc. Note that some issues only occur when ProfileInstruction.apply() is used. Any other type of exception that might happen are still ignored.

getDisposableProfile

@Nullable
@Internal
default @Nullable com.mojang.authlib.GameProfile getDisposableProfile()

Same as getProfile(), except some implementations of Profileable cannot inherently return any original instance as they're not cacheable, so this method ensures that no duplicate cloning of GameProfile occurs for performance.

For most implementations however, this defaults to a simple cloning of the cached instances.

Returns:

always a copied version of getProfile() that you can change. Null if getProfile() is null

transform

@NotNull
@Contract(value="_ -> new",
          pure=true)
default @NotNull Profileable transform(@NotNull
 @NotNull ProfileTransformer... transformers)

Adds transformer (read ProfileTransformer) information to a copied version of this profile (so it doesn't affect this instance, but the class type will change). So it's recommended to not chain this method and instead collect all transformers and call this method once for performance when necessary.

Profiles are copied before being transformed, so the main cache remains intact but the result of transformed profiles are never cached.

Parameters:

transformers - a list of transformers to apply in order once getProfile() is called.

getProfileValue

@Nullable
default @Nullable String getProfileValue()

A string representation of the getProfile() which is useful for data storage which can be serialized back using detect(String).

Note that in some cases this is the Base64 value of the textures property, but some may provide less verbose data when possible. Items and blocks can also provide compact data if their profile was built using ProfileTransformer.includeOriginalValue().

Returns:

null if getProfile() is null or the set profile doesn't have a texture property.

prepare

@NotNull
@Experimental
static <C extends Collection<Profileable>>
@NotNull CompletableFuture<C> prepare(@NotNull
 C profileables)

prepare

@NotNull
@Experimental
static <C extends Collection<Profileable>>
@NotNull CompletableFuture<C> prepare(@NotNull
 C profileables,
 @Nullable
 @Nullable ProfileRequestConfiguration config,
 @Nullable
 @Nullable com.google.common.base.Function<Throwable,Boolean> errorHandler)

username

@NotNull
@Contract(pure=true)
static @NotNull Profileable username(@NotNull
 @NotNull String username)

Sets the skull texture based on the specified player UUID (whether it's an offline or online UUID).

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull UUID uuid)

Sets the skull texture based on the specified player UUID (whether it's an offline or online UUID).

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull com.mojang.authlib.GameProfile profile)

Sets the skull texture based on the specified profile. If the profile already has textures, it will be used directly. Otherwise, a new profile will be fetched based on the UUID or username depending on the server's online mode.

Parameters:

profile - The profile to be used in the profile setting operation.

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull org.bukkit.OfflinePlayer offlinePlayer)

Sets the skull texture based on the specified offline player. The profile lookup will depend on whether the server is running in online mode.

Parameters:

offlinePlayer - The offline player to generate the GameProfile.

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull org.bukkit.block.BlockState blockState)

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull org.bukkit.block.Block block)

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull org.bukkit.inventory.ItemStack item)

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull org.bukkit.inventory.meta.ItemMeta meta)

detect

@NotNull
@Contract(pure=true)
static @NotNull Profileable detect(@NotNull
 @NotNull String input)

Sets the skull texture based on a string. The input type is resolved based on the value provided.

Valid Types

Username: A player username. (e.g. Notch)
UUID: A player UUID. Offline or online mode UUID. (e.g. 069a79f4-44e9-4726-a5be-fca90e38aaf5)
Base64: The Base64 encoded value of textures JSON. (e.g. eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvY2NmNjc2N2RkMzQ3MzdlOTliZDU0YjY5NWVmMDY4M2M2YzZjZTZhNTRmNjZhZDk3Mjk5MmJkMGU0OGU0NTc5YiJ9fX0=)
Minecraft Textures URL: Check ProfileInputType.TEXTURE_URL.
Minecraft Textures Hash: Same as the URL, but only including the hash part, excluding the base URL. (e.g. e5461a215b325fbdf892db67b7bfb60ad2bf1580dc968a15dfb304ccd5e74db)

Parameters:

input - The input value used to retrieve the GameProfile. For more information check ProfileInputType

of

@NotNull
@Contract(pure=true)
static @NotNull Profileable of(@NotNull
 @NotNull ProfileInputType type,
 @NotNull
 @NotNull String input)

Sets the skull texture based on a string with a known type.

Parameters:

type - The type of the input value.

input - The input value to generate the GameProfile.