Package net.kyori.adventure.identity

Interface Identity

All Superinterfaces:

net.kyori.examination.Examinable, Identified

public interface Identity
extends net.kyori.examination.Examinable, Identified

An identity used to track the sender of messages for the social interaction features introduced in Minecraft: Java Edition 1.16.4.

Since:

4.0.0

Since Minecraft:

1.16

Field Summary

Fields

Modifier and Type	Field	Description
static Pointer<Component>	DISPLAY_NAME	A pointer to a display name.
static Pointer<java.util.Locale>	LOCALE	A pointer to a Locale.
static Pointer<java.lang.String>	NAME	A pointer to a name.
static Pointer<java.util.UUID>	UUID	A pointer to a UUID.

Method Summary

Modifier and Type	Method	Description
default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
default @NotNull Identity	identity()	Gets the identity.
static @NotNull Identity	identity(@NotNull java.util.UUID uuid)	Creates an identity.
static @NotNull Identity	nil()	Gets the null identity.
@NotNull java.util.UUID	uuid()	Gets the uuid.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Field Detail

NAME

static final Pointer<java.lang.String> NAME

A pointer to a name.

Since:

4.8.0

UUID

static final Pointer<java.util.UUID> UUID

A pointer to a UUID.

Since:

4.8.0

DISPLAY_NAME

static final Pointer<Component> DISPLAY_NAME

A pointer to a display name.

Since:

4.8.0

LOCALE

static final Pointer<java.util.Locale> LOCALE

A pointer to a Locale.

Since:

4.9.0

Method Detail

nil

@NotNull
static @NotNull Identity nil()

Gets the null identity.

This should only be used when no players can be linked to a message.

Returns:

the null identity

Since:

4.0.0

identity

@NotNull
static @NotNull Identity identity(@NotNull
                                  @NotNull java.util.UUID uuid)

Creates an identity.

Parameters:

uuid - the uuid

Returns:

an identity

Since:

4.0.0

uuid

@NotNull
@NotNull java.util.UUID uuid()

Gets the uuid.

Returns:

the uuid

Since:

4.0.0

identity

@NotNull
default @NotNull Identity identity()

Description copied from interface: Identified

Gets the identity.

Specified by:

identity in interface Identified

Returns:

the identity

examinableProperties

@NotNull
default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface net.kyori.examination.Examinable