Package net.earthcomputer.multiconnect.api

Class MultiConnectAPI

java.lang.Object

net.earthcomputer.multiconnect.api.MultiConnectAPI

public class MultiConnectAPI
extends Object

The MultiConnect API

Constructor Summary

Constructors

Constructor	Description
MultiConnectAPI()

Method Summary

Modifier and Type	Method	Description
void	addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)	Adds a clientbound ICustomPayloadListener<Identifier>.
void	addClientboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)	Adds a clientbound ICustomPayloadListener<String>.
void	addIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)	Deprecated. Use addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.
void	addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)	Adds a serverbound ICustomPayloadListener<Identifier>.
void	addServerboundIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)	Deprecated. Use addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.
void	addServerboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)	Adds a serverbound ICustomPayloadListener<String>.
void	addServerboundStringCustomPayloadListener(IStringCustomPayloadListener listener)	Deprecated. Use addServerboundStringCustomPayloadListener(ICustomPayloadListener) instead.
void	addStringCustomPayloadListener(IStringCustomPayloadListener listener)	Deprecated. Use addClientboundStringCustomPayloadListener(ICustomPayloadListener) instead.
IProtocol	byProtocolVersion(int version)	Gets a supported IProtocol object by its protocol version, or null if the protocol is not supported
<T> boolean	doesServerKnow(net.minecraft.util.registry.Registry<T> registry, net.minecraft.util.registry.RegistryKey<T> key)	Returns whether the given registry contains the given value on the server.
<T> boolean	doesServerKnow(net.minecraft.util.registry.Registry<T> registry, T value)	Returns whether the given registry contains the given value on the server.
void	forceSendCustomPayload(net.minecraft.client.network.ClientPlayNetworkHandler networkHandler, net.minecraft.util.Identifier channel, net.minecraft.network.PacketByteBuf data)	By default, multiconnect blocks non-vanilla client-to-server custom payload packets.
void	forceSendCustomPayload(net.minecraft.util.Identifier channel, net.minecraft.network.PacketByteBuf data)	Deprecated. Use forceSendCustomPayload(ClientPlayNetworkHandler, Identifier, PacketByteBuf) instead.
void	forceSendStringCustomPayload(String channel, net.minecraft.network.PacketByteBuf data)	Deprecated. Use forceSendStringCustomPayload(ClientPlayNetworkHandler, String, PacketByteBuf) instead.
void	forceSendStringCustomPayload(net.minecraft.client.network.ClientPlayNetworkHandler networkHandler, String channel, net.minecraft.network.PacketByteBuf data)	By default, multiconnect blocks non-vanilla client-to-server custom payload packets.
int	getProtocolVersion()	Gets the protocol version of the server currently connected to, or the current game version if not connected to a server
List<IProtocol>	getSupportedProtocols()	Returns a list of supported protocols, from newest to oldest
static MultiConnectAPI	instance()	Returns the singleton instance of this API
void	removeClientboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)	Removes a clientbound ICustomPayloadListener<Identifier>.
void	removeClientboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)	Removes a clientbound ICustomPayloadListener<String>.
void	removeIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)	Deprecated. Use removeClientboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.
void	removeServerboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)	Removes a serverbound ICustomPayloadListener<Identifier>.
void	removeServerboundIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)	Deprecated. Use removeServerboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.
void	removeServerboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)	Removes a serverbound ICustomPayloadListener<String>.
void	removeServerboundStringCustomPayloadListener(IStringCustomPayloadListener listener)	Deprecated. Use removeServerboundStringCustomPayloadListener(ICustomPayloadListener) instead.
void	removeStringCustomPayloadListener(IStringCustomPayloadListener listener)	Deprecated. Use removeClientboundStringCustomPayloadListener(ICustomPayloadListener) instead.

Methods inherited from class java.lang.Object

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

Constructor Details

MultiConnectAPI

public MultiConnectAPI()

Method Details

instance

@ThreadSafe
public static MultiConnectAPI instance()

Returns the singleton instance of this API

getProtocolVersion

@ThreadSafe
public int getProtocolVersion()

Gets the protocol version of the server currently connected to, or the current game version if not connected to a server

byProtocolVersion

@ThreadSafe
public IProtocol byProtocolVersion(int version)

Gets a supported IProtocol object by its protocol version, or null if the protocol is not supported

getSupportedProtocols

@ThreadSafe
public List<IProtocol> getSupportedProtocols()

Returns a list of supported protocols, from newest to oldest

addClientboundIdentifierCustomPayloadListener

public void addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)

Adds a clientbound ICustomPayloadListener<Identifier>. Adding one of these listeners allows for mods to listen to non-vanilla CustomPayloadS2CPackets sent by servers on older versions. Such packets are blocked by multiconnect from normal handling.

This listener is not called for custom payloads from servers on the current version, as multiconnect does not block those. This listener is only called for servers on 1.13 and above; use addClientboundStringCustomPayloadListener(ICustomPayloadListener) if you want to listen to custom payloads from older servers.

removeClientboundIdentifierCustomPayloadListener

public void removeClientboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)

Removes a clientbound ICustomPayloadListener<Identifier>.

See Also:

• addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener)

addClientboundStringCustomPayloadListener

public void addClientboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)

Adds a clientbound ICustomPayloadListener<String>. Adding one of these listeners allows for mods to listen to non-vanilla CustomPayloadS2CPackets sent by servers on 1.12.2 or below. Such packets are blocked by multiconnect from normal handling.

This listener is not called for custom payloads from servers on 1.13 or above. To listen for these custom payloads, use addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener), or if the server is on the current Minecraft version, simply do it the normal way.

removeClientboundStringCustomPayloadListener

public void removeClientboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)

Removes a clientbound ICustomPayloadListener<String>.

See Also:

• addClientboundStringCustomPayloadListener(ICustomPayloadListener)

forceSendCustomPayload

@ThreadSafe
public void forceSendCustomPayload(net.minecraft.client.network.ClientPlayNetworkHandler networkHandler,
 net.minecraft.util.Identifier channel,
 net.minecraft.network.PacketByteBuf data)

By default, multiconnect blocks non-vanilla client-to-server custom payload packets. Use this method to send one anyway.

Parameters:

networkHandler - The network handler

channel - The channel to send data on

data - The data to send

forceSendStringCustomPayload

@ThreadSafe
public void forceSendStringCustomPayload(net.minecraft.client.network.ClientPlayNetworkHandler networkHandler,
 String channel,
 net.minecraft.network.PacketByteBuf data)

By default, multiconnect blocks non-vanilla client-to-server custom payload packets. Use this method to send one anyway to a 1.12.2 or below server.

Parameters:

networkHandler - The network handler

channel - The channel to send data on

data - The data to send

addServerboundIdentifierCustomPayloadListener

public void addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)

Adds a serverbound ICustomPayloadListener<Identifier>. Adding one of these listeners allows for mods to listen to non-vanilla CustomPayloadS2CPackets sent by clientside mods to servers on older versions. Such packets are blocked by multiconnect from being sent.

This listener is not called for custom payloads to servers on the current version, as multiconnect does not block those. This listener is only called for servers on 1.13 and above; use addServerboundStringCustomPayloadListener(ICustomPayloadListener) if you want to listen to custom payloads to older servers. This listener is also not called for custom payloads on vanilla channels, as these are also not blocked by multiconnect.

removeServerboundIdentifierCustomPayloadListener

public void removeServerboundIdentifierCustomPayloadListener(ICustomPayloadListener<net.minecraft.util.Identifier> listener)

Removes a serverbound ICustomPayloadListener<Identifier>.

See Also:

• addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener)

addServerboundStringCustomPayloadListener

public void addServerboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)

Adds a serverbound ICustomPayloadListener<String>. Adding one of these listeners allows for mods to listen to non-vanilla CustomPayloadS2CPackets sent by clientside mods to servers on 1.12.2 or below. Such packets are blocked by multiconnect from being sent.

This listener is not called for custom payloads to servers on 1.13 or above. To listen for these custom payloads, use addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener), or if the server is on the current Minecraft version, simply let the packet be sent the normal way. This listener is also not called for custom payloads on vanilla channels, as these are also not blocked by multiconnect.

removeServerboundStringCustomPayloadListener

public void removeServerboundStringCustomPayloadListener(ICustomPayloadListener<String> listener)

Removes a serverbound ICustomPayloadListener<String>.

See Also:

• addServerboundStringCustomPayloadListener(ICustomPayloadListener)

doesServerKnow

@ThreadSafe
public <T> boolean doesServerKnow(net.minecraft.util.registry.Registry<T> registry,
 T value)

Returns whether the given registry contains the given value on the server.

doesServerKnow

@ThreadSafe
public <T> boolean doesServerKnow(net.minecraft.util.registry.Registry<T> registry,
 net.minecraft.util.registry.RegistryKey<T> key)

Returns whether the given registry contains the given value on the server.

addIdentifierCustomPayloadListener

@Deprecated
public void addIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)

Deprecated.

Use addClientboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.

removeIdentifierCustomPayloadListener

@Deprecated
public void removeIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)

Deprecated.

Use removeClientboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.

addStringCustomPayloadListener

@Deprecated
public void addStringCustomPayloadListener(IStringCustomPayloadListener listener)

Deprecated.

Use addClientboundStringCustomPayloadListener(ICustomPayloadListener) instead.

removeStringCustomPayloadListener

@Deprecated
public void removeStringCustomPayloadListener(IStringCustomPayloadListener listener)

Deprecated.

Use removeClientboundStringCustomPayloadListener(ICustomPayloadListener) instead.

forceSendCustomPayload

@Deprecated
public void forceSendCustomPayload(net.minecraft.util.Identifier channel,
 net.minecraft.network.PacketByteBuf data)

Deprecated.

Use forceSendCustomPayload(ClientPlayNetworkHandler, Identifier, PacketByteBuf) instead. MinecraftClient.getInstance().getNetworkHandler() can return null before the game join packet has been received.

forceSendStringCustomPayload

@Deprecated
public void forceSendStringCustomPayload(String channel,
 net.minecraft.network.PacketByteBuf data)

Deprecated.

Use forceSendStringCustomPayload(ClientPlayNetworkHandler, String, PacketByteBuf) instead. MinecraftClient.getInstance().getNetworkHandler() can return null before the game join packet has been received.

addServerboundIdentifierCustomPayloadListener

@Deprecated
public void addServerboundIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)

Deprecated.

Use addServerboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.

removeServerboundIdentifierCustomPayloadListener

@Deprecated
public void removeServerboundIdentifierCustomPayloadListener(IIdentifierCustomPayloadListener listener)

Deprecated.

Use removeServerboundIdentifierCustomPayloadListener(ICustomPayloadListener) instead.

addServerboundStringCustomPayloadListener

@Deprecated
public void addServerboundStringCustomPayloadListener(IStringCustomPayloadListener listener)

Deprecated.

Use addServerboundStringCustomPayloadListener(ICustomPayloadListener) instead.

removeServerboundStringCustomPayloadListener

@Deprecated
public void removeServerboundStringCustomPayloadListener(IStringCustomPayloadListener listener)

Deprecated.

Use removeServerboundStringCustomPayloadListener(ICustomPayloadListener) instead.