From 6446e1a88825c9c4303319a4a710d852d13eb5e8 Mon Sep 17 00:00:00 2001 From: apple502j <33279053+apple502j@users.noreply.github.com> Date: Thu, 2 Jun 2022 02:39:22 +0900 Subject: [PATCH] Move message related stuff to a new package (#3185) * Move message related stuff to a new package * Fix javadoc * Fix javadoc Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../client/network/ClientPlayerEntity.mapping | 2 +- .../argument/MessageArgumentType.mapping | 2 +- .../ArgumentSignatureDataMap.mapping | 2 +- .../ChatMessageSigner.mapping | 4 +-- .../CommandArgumentSigner.mapping | 2 +- .../{ => message}/MessageDecorator.mapping | 0 .../{ => message}/MessageSender.mapping | 2 +- .../MessageSignature.mapping} | 5 +-- .../network/{ => message}/MessageType.mapping | 2 +- .../SignedMessage.mapping} | 4 +-- .../s2c/play/ChatMessageS2CPacket.mapping | 4 +-- .../minecraft/server/PlayerManager.mapping | 32 +++++++++---------- .../server/network/ServerPlayerEntity.mapping | 6 ++-- 13 files changed, 34 insertions(+), 33 deletions(-) rename mappings/net/minecraft/network/{encryption => message}/ArgumentSignatureDataMap.mapping (93%) rename mappings/net/minecraft/network/{encryption => message}/ChatMessageSigner.mapping (81%) rename mappings/net/minecraft/network/{encryption => message}/CommandArgumentSigner.mapping (87%) rename mappings/net/minecraft/network/{ => message}/MessageDecorator.mapping (100%) rename mappings/net/minecraft/network/{ => message}/MessageSender.mapping (88%) rename mappings/net/minecraft/network/{encryption/ChatMessageSignature.mapping => message/MessageSignature.mapping} (90%) rename mappings/net/minecraft/network/{ => message}/MessageType.mapping (99%) rename mappings/net/minecraft/network/{encryption/SignedChatMessage.mapping => message/SignedMessage.mapping} (94%) diff --git a/mappings/net/minecraft/client/network/ClientPlayerEntity.mapping b/mappings/net/minecraft/client/network/ClientPlayerEntity.mapping index ac04a310fb..a162eb8b65 100644 --- a/mappings/net/minecraft/client/network/ClientPlayerEntity.mapping +++ b/mappings/net/minecraft/client/network/ClientPlayerEntity.mapping @@ -112,7 +112,7 @@ CLASS net/minecraft/class_746 net/minecraft/client/network/ClientPlayerEntity METHOD method_33689 init ()V METHOD method_43609 signChatMessage (Lnet/minecraft/class_7470;Lnet/minecraft/class_2561;)Lnet/minecraft/class_7469; COMMENT Signs the chat message. If the chat message cannot be signed, this will return - COMMENT {@link ChatMessageSignature#none()}. + COMMENT {@link MessageSignature#none()}. ARG 1 signer ARG 2 message METHOD method_43786 signArguments (Lnet/minecraft/class_7470;Lcom/mojang/brigadier/ParseResults;Lnet/minecraft/class_2561;)Lnet/minecraft/class_7450; diff --git a/mappings/net/minecraft/command/argument/MessageArgumentType.mapping b/mappings/net/minecraft/command/argument/MessageArgumentType.mapping index 3f3a30a735..16604dc8fd 100644 --- a/mappings/net/minecraft/command/argument/MessageArgumentType.mapping +++ b/mappings/net/minecraft/command/argument/MessageArgumentType.mapping @@ -63,7 +63,7 @@ CLASS net/minecraft/class_2196 net/minecraft/command/argument/MessageArgumentTyp COMMENT {@return the verifiable part of {@code message}, or {@code null} when there is none} COMMENT COMMENT @implNote If the preview is signed, the decorated message will be returned, and - COMMENT if it's unsigned or unpreviewed but {@linkplain ChatMessageSignature#canVerify + COMMENT if it's unsigned or unpreviewed but {@linkplain MessageSignature#canVerify COMMENT verifiable}, the plain, undecorated message will be returned. If neither is true, COMMENT this returns {@code null}, since the message cannot be verified in any way. ARG 1 decorated diff --git a/mappings/net/minecraft/network/encryption/ArgumentSignatureDataMap.mapping b/mappings/net/minecraft/network/message/ArgumentSignatureDataMap.mapping similarity index 93% rename from mappings/net/minecraft/network/encryption/ArgumentSignatureDataMap.mapping rename to mappings/net/minecraft/network/message/ArgumentSignatureDataMap.mapping index 215fa0bf3e..996df8dc13 100644 --- a/mappings/net/minecraft/network/encryption/ArgumentSignatureDataMap.mapping +++ b/mappings/net/minecraft/network/message/ArgumentSignatureDataMap.mapping @@ -1,4 +1,4 @@ -CLASS net/minecraft/class_7450 net/minecraft/network/encryption/ArgumentSignatureDataMap +CLASS net/minecraft/class_7450 net/minecraft/network/message/ArgumentSignatureDataMap COMMENT A record holding the salt and signatures for all signable arguments of an executed command. FIELD field_39185 MAX_ARGUMENT_NAME_LENGTH I FIELD field_39418 MAX_ARGUMENTS I diff --git a/mappings/net/minecraft/network/encryption/ChatMessageSigner.mapping b/mappings/net/minecraft/network/message/ChatMessageSigner.mapping similarity index 81% rename from mappings/net/minecraft/network/encryption/ChatMessageSigner.mapping rename to mappings/net/minecraft/network/message/ChatMessageSigner.mapping index e2480b9713..a45cbad53e 100644 --- a/mappings/net/minecraft/network/encryption/ChatMessageSigner.mapping +++ b/mappings/net/minecraft/network/message/ChatMessageSigner.mapping @@ -1,5 +1,5 @@ -CLASS net/minecraft/class_7470 net/minecraft/network/encryption/ChatMessageSigner - COMMENT A signer for chat messages that produces {@link ChatMessageSignature}. +CLASS net/minecraft/class_7470 net/minecraft/network/message/ChatMessageSigner + COMMENT A signer for chat messages that produces {@link MessageSignature}. METHOD method_43864 sign (Lnet/minecraft/class_7501;Ljava/lang/String;)Lnet/minecraft/class_7469; COMMENT {@return the chat message signature obtained by signing {@code message} with {@code signature}} ARG 1 signer diff --git a/mappings/net/minecraft/network/encryption/CommandArgumentSigner.mapping b/mappings/net/minecraft/network/message/CommandArgumentSigner.mapping similarity index 87% rename from mappings/net/minecraft/network/encryption/CommandArgumentSigner.mapping rename to mappings/net/minecraft/network/message/CommandArgumentSigner.mapping index b01c9d88a3..2036082c03 100644 --- a/mappings/net/minecraft/network/encryption/CommandArgumentSigner.mapping +++ b/mappings/net/minecraft/network/message/CommandArgumentSigner.mapping @@ -1,4 +1,4 @@ -CLASS net/minecraft/class_7448 net/minecraft/network/encryption/CommandArgumentSigner +CLASS net/minecraft/class_7448 net/minecraft/network/message/CommandArgumentSigner COMMENT A signer for command arguments. FIELD field_39182 NONE Lnet/minecraft/class_7448; METHOD getArgumentSignature (Ljava/lang/String;)Lnet/minecraft/class_7469; diff --git a/mappings/net/minecraft/network/MessageDecorator.mapping b/mappings/net/minecraft/network/message/MessageDecorator.mapping similarity index 100% rename from mappings/net/minecraft/network/MessageDecorator.mapping rename to mappings/net/minecraft/network/message/MessageDecorator.mapping diff --git a/mappings/net/minecraft/network/MessageSender.mapping b/mappings/net/minecraft/network/message/MessageSender.mapping similarity index 88% rename from mappings/net/minecraft/network/MessageSender.mapping rename to mappings/net/minecraft/network/message/MessageSender.mapping index d0fa9fc2ab..299f291e1e 100644 --- a/mappings/net/minecraft/network/MessageSender.mapping +++ b/mappings/net/minecraft/network/message/MessageSender.mapping @@ -1,4 +1,4 @@ -CLASS net/minecraft/class_7436 net/minecraft/network/MessageSender +CLASS net/minecraft/class_7436 net/minecraft/network/message/MessageSender COMMENT The sender, or the source, of a message. COMMENT COMMENT

An instance can be obtained via {@link net.minecraft.entity.Entity#asMessageSender}. diff --git a/mappings/net/minecraft/network/encryption/ChatMessageSignature.mapping b/mappings/net/minecraft/network/message/MessageSignature.mapping similarity index 90% rename from mappings/net/minecraft/network/encryption/ChatMessageSignature.mapping rename to mappings/net/minecraft/network/message/MessageSignature.mapping index 1cf3a2608e..55f443342e 100644 --- a/mappings/net/minecraft/network/encryption/ChatMessageSignature.mapping +++ b/mappings/net/minecraft/network/message/MessageSignature.mapping @@ -1,5 +1,6 @@ -CLASS net/minecraft/class_7469 net/minecraft/network/encryption/ChatMessageSignature - COMMENT A signature for chat messages, consisting of the sender, the timestamp, and the signature data. +CLASS net/minecraft/class_7469 net/minecraft/network/message/MessageSignature + COMMENT A signature for chat messages and message command arguments, consisting + COMMENT of the sender, the timestamp, and the signature data. FIELD comp_799 timestamp Ljava/time/Instant; METHOD comp_799 timestamp ()Ljava/time/Instant; METHOD method_43859 none ()Lnet/minecraft/class_7469; diff --git a/mappings/net/minecraft/network/MessageType.mapping b/mappings/net/minecraft/network/message/MessageType.mapping similarity index 99% rename from mappings/net/minecraft/network/MessageType.mapping rename to mappings/net/minecraft/network/message/MessageType.mapping index 08ef5346ba..cad934c67a 100644 --- a/mappings/net/minecraft/network/MessageType.mapping +++ b/mappings/net/minecraft/network/message/MessageType.mapping @@ -1,4 +1,4 @@ -CLASS net/minecraft/class_2556 net/minecraft/network/MessageType +CLASS net/minecraft/class_2556 net/minecraft/network/message/MessageType COMMENT A message type (also known as "chat type") controls whether to display or narrate COMMENT the messages sent to the clients, and if so, how. Message types are registered COMMENT at {@link net.minecraft.util.registry.BuiltinRegistries#MESSAGE_TYPE}. When diff --git a/mappings/net/minecraft/network/encryption/SignedChatMessage.mapping b/mappings/net/minecraft/network/message/SignedMessage.mapping similarity index 94% rename from mappings/net/minecraft/network/encryption/SignedChatMessage.mapping rename to mappings/net/minecraft/network/message/SignedMessage.mapping index 7a251d3f9c..b5ce4d0c12 100644 --- a/mappings/net/minecraft/network/encryption/SignedChatMessage.mapping +++ b/mappings/net/minecraft/network/message/SignedMessage.mapping @@ -1,5 +1,5 @@ -CLASS net/minecraft/class_7471 net/minecraft/network/encryption/SignedChatMessage - COMMENT A signed chat message, consisting of the signature, the signed content, +CLASS net/minecraft/class_7471 net/minecraft/network/message/SignedMessage + COMMENT A signed message, consisting of the signature, the signed content, COMMENT and the optional unsigned content supplied when the chat decorator produced COMMENT unsigned message due to the chat preview being disabled on either side. COMMENT diff --git a/mappings/net/minecraft/network/packet/s2c/play/ChatMessageS2CPacket.mapping b/mappings/net/minecraft/network/packet/s2c/play/ChatMessageS2CPacket.mapping index 3023edc79b..8f1e87627e 100644 --- a/mappings/net/minecraft/network/packet/s2c/play/ChatMessageS2CPacket.mapping +++ b/mappings/net/minecraft/network/packet/s2c/play/ChatMessageS2CPacket.mapping @@ -12,11 +12,11 @@ CLASS net/minecraft/class_7438 net/minecraft/network/packet/s2c/play/ChatMessage COMMENT discarded by the clients; they instead log a warning. COMMENT COMMENT

Chat messages have signatures. It is possible to use a bogus signature - such as - COMMENT {@link net.minecraft.network.encryption.ChatMessageSignature#none} - to send a chat + COMMENT {@link net.minecraft.network.message.MessageSignature#none} - to send a chat COMMENT message; however if the signature is invalid (e.g. because the text's content differs COMMENT from the one sent by the client, or because the passed signature is invalid) the client COMMENT will log a warning. See {@link - COMMENT net.minecraft.network.encryption.ChatMessageSignature#updateSignature} for how the + COMMENT net.minecraft.network.message.MessageSignature#updateSignature} for how the COMMENT message is signed. COMMENT COMMENT @see net.minecraft.server.network.ServerPlayerEntity#sendChatMessage diff --git a/mappings/net/minecraft/server/PlayerManager.mapping b/mappings/net/minecraft/server/PlayerManager.mapping index f2d4f29598..5e4d399f81 100644 --- a/mappings/net/minecraft/server/PlayerManager.mapping +++ b/mappings/net/minecraft/server/PlayerManager.mapping @@ -147,8 +147,8 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerCommandSource, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerPlayerEntity, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, MessageSender, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, Function, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, Function, MessageSender, RegistryKey) ARG 1 message ARG 2 playerMessageFactory COMMENT a function that takes the player to send the message to @@ -160,11 +160,11 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT message can be sent to a different player. COMMENT COMMENT

Chat messages have signatures. It is possible to use a bogus signature - such as - COMMENT {@link net.minecraft.network.encryption.ChatMessageSignature#none} - to send a chat + COMMENT {@link net.minecraft.network.message.MessageSignature#none} - to send a chat COMMENT message; however if the signature is invalid (e.g. because the text's content differs COMMENT from the one sent by the client, or because the passed signature is invalid) the client COMMENT will log a warning. See {@link - COMMENT net.minecraft.network.encryption.ChatMessageSignature#updateSignature} for how the + COMMENT net.minecraft.network.message.MessageSignature#updateSignature} for how the COMMENT message is signed. COMMENT COMMENT @apiNote This method is used to broadcast a message sent by a player @@ -176,7 +176,7 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, Function, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerCommandSource, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerPlayerEntity, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, MessageSender, RegistryKey) ARG 1 message ARG 2 playerMessageFactory COMMENT a function that takes the player to send the message to @@ -193,8 +193,8 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, Function, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerCommandSource, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerPlayerEntity, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, MessageSender, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, Function, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, Function, MessageSender, RegistryKey) ARG 1 message ARG 2 typeKey METHOD method_43670 (Lnet/minecraft/class_3222;Lnet/minecraft/server/MinecraftServer$class_7460;)V @@ -205,11 +205,11 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT Broadcasts a chat message to all players and the server console. COMMENT COMMENT

Chat messages have signatures. It is possible to use a bogus signature - such as - COMMENT {@link net.minecraft.network.encryption.ChatMessageSignature#none} - to send a chat + COMMENT {@link net.minecraft.network.message.MessageSignature#none} - to send a chat COMMENT message; however if the signature is invalid (e.g. because the text's content differs COMMENT from the one sent by the client, or because the passed signature is invalid) the client COMMENT will log a warning. See {@link - COMMENT net.minecraft.network.encryption.ChatMessageSignature#updateSignature} for how the + COMMENT net.minecraft.network.message.MessageSignature#updateSignature} for how the COMMENT message is signed. COMMENT COMMENT @apiNote This method is used to broadcast a message sent by a player @@ -220,8 +220,8 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, RegistryKey) COMMENT @see #broadcast(Text, Function, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerCommandSource, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, MessageSender, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, Function, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, Function, MessageSender, RegistryKey) ARG 1 message ARG 2 sender ARG 3 typeKey @@ -229,11 +229,11 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT Broadcasts a chat message to all players and the server console. COMMENT COMMENT

Chat messages have signatures. It is possible to use a bogus signature - such as - COMMENT {@link net.minecraft.network.encryption.ChatMessageSignature#none} - to send a chat + COMMENT {@link net.minecraft.network.message.MessageSignature#none} - to send a chat COMMENT message; however if the signature is invalid (e.g. because the text's content differs COMMENT from the one sent by the client, or because the passed signature is invalid) the client COMMENT will log a warning. See {@link - COMMENT net.minecraft.network.encryption.ChatMessageSignature#updateSignature} for how the + COMMENT net.minecraft.network.message.MessageSignature#updateSignature} for how the COMMENT message is signed. COMMENT COMMENT @apiNote This method is used to broadcast messages from commands like {@link @@ -243,7 +243,7 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, Function, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerCommandSource, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerPlayerEntity, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, Function, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, Function, MessageSender, RegistryKey) ARG 1 message ARG 2 sender ARG 3 typeKey @@ -259,8 +259,8 @@ CLASS net/minecraft/class_3324 net/minecraft/server/PlayerManager COMMENT @see #broadcast(Text, RegistryKey) COMMENT @see #broadcast(Text, Function, RegistryKey) COMMENT @see #broadcast(FilteredMessage, ServerPlayerEntity, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, MessageSender, RegistryKey) - COMMENT @see #broadcast(SignedChatMessage, Function, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, MessageSender, RegistryKey) + COMMENT @see #broadcast(SignedMessage, Function, MessageSender, RegistryKey) ARG 1 message ARG 2 source ARG 3 typeKey diff --git a/mappings/net/minecraft/server/network/ServerPlayerEntity.mapping b/mappings/net/minecraft/server/network/ServerPlayerEntity.mapping index 1f760008e7..a1f56775f2 100644 --- a/mappings/net/minecraft/server/network/ServerPlayerEntity.mapping +++ b/mappings/net/minecraft/server/network/ServerPlayerEntity.mapping @@ -220,18 +220,18 @@ CLASS net/minecraft/class_3222 net/minecraft/server/network/ServerPlayerEntity COMMENT Sends a message to the player. COMMENT COMMENT @see #sendMessage(Text) - COMMENT @see #sendChatMessage(SignedChatMessage, ChatMessageSender, RegistryKey) + COMMENT @see #sendChatMessage(SignedMessage, ChatMessageSender, RegistryKey) ARG 1 message ARG 2 typeKey METHOD method_43505 sendChatMessage (Lnet/minecraft/class_7471;Lnet/minecraft/class_7436;Lnet/minecraft/class_5321;)V COMMENT Sends a chat message to the player. COMMENT COMMENT

Chat messages have signatures. It is possible to use a bogus signature - such as - COMMENT {@link net.minecraft.network.encryption.ChatMessageSignature#none} - to send a chat + COMMENT {@link net.minecraft.network.message.MessageSignature#none} - to send a chat COMMENT message; however if the signature is invalid (e.g. because the text's content differs COMMENT from the one sent by the client, or because the passed signature is invalid) the client COMMENT will log a warning. See {@link - COMMENT net.minecraft.network.encryption.ChatMessageSignature#updateSignature} for how the + COMMENT net.minecraft.network.message.MessageSignature#updateSignature} for how the COMMENT message is signed. COMMENT COMMENT @see #sendMessage(Text)