Module net.kyori.adventure.api
Package net.kyori.adventure.identity

Interface Identity

All Superinterfaces:
Identified
public sealed interface Identity extends 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 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

    • LOCALE

      static final Pointer<Locale> LOCALE
      A pointer to a Locale.
      Since:
      4.9.0

  • Method Details

    • nil

      static 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

      static Identity identity(UUID uuid)
      Creates an identity.
      Parameters:
      uuid - the uuid
      Returns:
      an identity
      Since:
      4.0.0

    • uuid

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

    • identity

      default Identity identity()
      Description copied from interface: Identified
      Gets the identity.
      Specified by:
      identity in interface Identified
      Returns:
      the identity