diff --git a/common/src/main/java/dev/architectury/networking/simple/SimpleNetworkManager.java b/common/src/main/java/dev/architectury/networking/simple/SimpleNetworkManager.java index 4a286aaa..af1f0458 100644 --- a/common/src/main/java/dev/architectury/networking/simple/SimpleNetworkManager.java +++ b/common/src/main/java/dev/architectury/networking/simple/SimpleNetworkManager.java @@ -24,6 +24,7 @@ import dev.architectury.networking.transformers.PacketTransformer; import dev.architectury.platform.Platform; import dev.architectury.utils.Env; import net.minecraft.resources.ResourceLocation; +import org.jetbrains.annotations.ApiStatus; import java.util.List; @@ -54,6 +55,9 @@ public class SimpleNetworkManager { /** * Convenience method to register a server -> client message with no packet transformers. * + * @param id a unique ID for the message, must be a valid value for {@link ResourceLocation#getPath} + * @param decoder the message decoder for the message + * @return a {@link MessageType} describing the registered message * @see #registerS2C(String, MessageDecoder, List) */ public MessageType registerS2C(String id, MessageDecoder decoder) { @@ -61,13 +65,14 @@ public class SimpleNetworkManager { } /** - * Registers a server -> client message. + * Registers a server -> client message using the given packet transformers. * * @param id a unique ID for the message, must be a valid value for {@link ResourceLocation#getPath} * @param decoder the message decoder for the message * @param transformers a list of packet transformers to apply to the message packet * @return a {@link MessageType} describing the registered message */ + @ApiStatus.Experimental public MessageType registerS2C(String id, MessageDecoder decoder, List transformers) { MessageType messageType = new MessageType(this, new ResourceLocation(namespace, id), NetworkManager.s2c()); @@ -82,6 +87,9 @@ public class SimpleNetworkManager { /** * Convenience method to register a client -> server message with no packet transformers. * + * @param id a unique ID for the message, must be a valid value for {@link ResourceLocation#getPath} + * @param decoder the message decoder for the message + * @return a {@link MessageType} describing the registered message * @see #registerC2S(String, MessageDecoder, List) */ public MessageType registerC2S(String id, MessageDecoder decoder) { @@ -89,13 +97,14 @@ public class SimpleNetworkManager { } /** - * Registers a client -> server message. + * Registers a client -> server message using the given packet transformers. * * @param id a unique ID for the message, must be a valid value for {@link ResourceLocation#getPath} * @param decoder the message decoder for the message * @param transformers a list of packet transformers to apply to the message packet * @return a {@link MessageType} describing the registered message */ + @ApiStatus.Experimental public MessageType registerC2S(String id, MessageDecoder decoder, List transformers) { MessageType messageType = new MessageType(this, new ResourceLocation(namespace, id), NetworkManager.c2s()); NetworkManager.NetworkReceiver receiver = decoder.createReceiver();