Module net.kyori.adventure.api
Package net.kyori.adventure.chat

Interface ChatType

public interface ChatType
A type of chat.
Since:
4.12.0
Since Minecraft:
1.19

  • Field Details

    • CHAT

      static final ChatType CHAT
      A chat message from a player.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • SAY_COMMAND

      static final ChatType SAY_COMMAND
      A message send as a result of using the /say command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • MSG_COMMAND_INCOMING

      static final ChatType MSG_COMMAND_INCOMING
      A message received as a result of using the /msg command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • MSG_COMMAND_OUTGOING

      static final ChatType MSG_COMMAND_OUTGOING
      A message sent as a result of using the /msg command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • TEAM_MSG_COMMAND_INCOMING

      static final ChatType TEAM_MSG_COMMAND_INCOMING
      A message received as a result of using the /teammsg command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • TEAM_MSG_COMMAND_OUTGOING

      static final ChatType TEAM_MSG_COMMAND_OUTGOING
      A message sent as a result of using the /teammsg command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • EMOTE_COMMAND

      static final ChatType EMOTE_COMMAND
      A message sent as a result of using the /me command.
      Since:
      4.12.0
      Since Minecraft:
      1.19

  • Method Details

    • chatType

      static ChatType chatType(Keyed key)
      Creates a new chat type with a given key.
      Parameters:
      key - the key
      Returns:
      the chat type
      Since:
      4.12.0

    • bind

      @Contract(value="_ -> new", pure=true) default ChatType.Bound bind(ComponentLike name)
      Creates a bound chat type with a name Component.
      Parameters:
      name - the name component
      Returns:
      a new bound chat type
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • bind

      @Contract(value="_, _ -> new", pure=true) default ChatType.Bound bind(ComponentLike name, @Nullable ComponentLike target)
      Creates a bound chat type with a name and target Component.
      Parameters:
      name - the name component
      target - the optional target component
      Returns:
      a new bound chat type
      Since:
      4.12.0
      Since Minecraft:
      1.19

    • key

      @Nullable Key key()
      Gets the key associated with this chat type.

      In some circumstances, such as an inlined chat type, there may not be a key. In these cases, this method will return null.

      Returns:
      the key, if possible
      Since:
      4.12.0