Package net.kyori.adventure.chat
Interface ChatType
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ChatType.Bound
A boundChatType
.
-
Field Summary
Fields Modifier and Type Field Description static ChatType
CHAT
A chat message from a player.static ChatType
EMOTE_COMMAND
A message sent as a result of using the/me
command.static ChatType
MSG_COMMAND_INCOMING
A message received as a result of using the/msg
command.static ChatType
MSG_COMMAND_OUTGOING
A message sent as a result of using the/msg
command.static ChatType
SAY_COMMAND
A message send as a result of using the/say
command.static ChatType
TEAM_MSG_COMMAND_INCOMING
A message received as a result of using the/teammsg
command.static ChatType
TEAM_MSG_COMMAND_OUTGOING
A message sent as a result of using the/teammsg
command.
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default @NotNull ChatType.Bound
bind(@NotNull ComponentLike name)
Creates a bound chat type with a nameComponent
.default @NotNull ChatType.Bound
bind(@NotNull ComponentLike name, @Nullable ComponentLike target)
Creates a bound chat type with a name and targetComponent
.static @NotNull ChatType
chatType(@NotNull Keyed key)
Creates a new chat type with a given key.default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>
examinableProperties()
-
-
-
Field Detail
-
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 Detail
-
chatType
@NotNull static @NotNull ChatType chatType(@NotNull @NotNull 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 @NotNull ChatType.Bound bind(@NotNull @NotNull ComponentLike name)
Creates a bound chat type with a nameComponent
.- 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 @NotNull ChatType.Bound bind(@NotNull @NotNull ComponentLike name, @Nullable @Nullable ComponentLike target)
Creates a bound chat type with a name and targetComponent
.- Parameters:
name
- the name componenttarget
- the optional target component- Returns:
- a new bound chat type
- Since:
- 4.12.0
- Since Minecraft:
- 1.19
-
examinableProperties
@NotNull default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
-
-