Package dev.architectury.networking.simple

Class SimpleNetworkManager

java.lang.Object

dev.architectury.networking.simple.SimpleNetworkManager

public class SimpleNetworkManager
extends Object

A simple wrapper for NetworkManager to make it easier to register messages and send them to clients/servers.

Field Summary

Fields

Modifier and Type	Field	Description
final String	namespace	The unique namespace for the messages managed by this manager.

Method Summary

Modifier and Type	Method	Description
static SimpleNetworkManager	create(String namespace)	Creates a new SimpleNetworkManager.
MessageType	registerC2S(String id, MessageDecoder<BaseC2SMessage> decoder)	Registers a client -> server message with no packet transformers.
MessageType	registerC2S(String id, MessageDecoder<BaseC2SMessage> decoder, List<PacketTransformer> transformers)	Registers a client -> server message using the given packet transformers.
MessageType	registerS2C(String id, MessageDecoder<BaseS2CMessage> decoder)	Registers a server -> client message with no packet transformers.
MessageType	registerS2C(String id, MessageDecoder<BaseS2CMessage> decoder, List<PacketTransformer> transformers)	Registers a server -> client message using the given packet transformers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

namespace

public final String namespace

The unique namespace for the messages managed by this manager. This will typically be a mod ID.

Method Details

create

public static SimpleNetworkManager create(String namespace)

Creates a new SimpleNetworkManager.

Parameters:

namespace - a unique namespace for the messages (namespace)

Returns:

the created network manager

registerS2C

public MessageType registerS2C(String id,
 MessageDecoder<BaseS2CMessage> decoder)

Registers a server -> client message with no packet transformers.

Parameters:

id - a unique ID for the message, must be a valid value for ResourceLocation.getPath()

decoder - the message decoder for the message

Returns:

a MessageType describing the registered message

See Also:

• registerS2C(String, MessageDecoder, List)

registerS2C

@Experimental
public MessageType registerS2C(String id,
 MessageDecoder<BaseS2CMessage> decoder,
 List<PacketTransformer> transformers)

Registers a server -> client message using the given packet transformers.

Parameters:

id - a unique ID for the message, must be a valid value for ResourceLocation.getPath()

decoder - the message decoder for the message

transformers - a list of packet transformers to apply to the message packet

Returns:

a MessageType describing the registered message

registerC2S

public MessageType registerC2S(String id,
 MessageDecoder<BaseC2SMessage> decoder)

Registers a client -> server message with no packet transformers.

Parameters:

id - a unique ID for the message, must be a valid value for ResourceLocation.getPath()

decoder - the message decoder for the message

Returns:

a MessageType describing the registered message

See Also:

• registerC2S(String, MessageDecoder, List)

registerC2S

@Experimental
public MessageType registerC2S(String id,
 MessageDecoder<BaseC2SMessage> decoder,
 List<PacketTransformer> transformers)

Registers a client -> server message using the given packet transformers.

Parameters:

id - a unique ID for the message, must be a valid value for ResourceLocation.getPath()

decoder - the message decoder for the message

transformers - a list of packet transformers to apply to the message packet

Returns:

a MessageType describing the registered message