Package net.kyori.adventure.identity

Interface Identity

All Superinterfaces:
net.kyori.examination.Examinable
public interface Identity
extends net.kyori.examination.Examinable
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<String> NAME
    A pointer to a name.
    static Pointer<UUID> UUID
    A pointer to a UUID.

  • Method Summary

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

    Methods inherited from interface net.kyori.examination.Examinable

    examinableName, examine

  • Field Details

    • NAME

      static final Pointer<String> NAME
      A pointer to a name.
      Since:
      4.8.0

    • UUID

      static final Pointer<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

  • Method Details

    • 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 UUID uuid)
      Creates an identity.
      Parameters:
      uuid - the uuid
      Returns:
      an identity
      Since:
      4.0.0

    • uuid

      @NotNull @NotNull UUID uuid()
      Gets the uuid.
      Returns:
      the uuid
      Since:
      4.0.0

    • examinableProperties

      @NotNull default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
      Specified by:
      examinableProperties in interface net.kyori.examination.Examinable