Package com.viaversion.viaversion.api.platform

Interface ViaInjector

public interface ViaInjector

Method Summary

Modifier and Type	Method	Description
default String	getDecoderName()	Get the name of the decoder for the netty pipeline for this platform.
com.google.gson.JsonObject	getDump()	Get any relevant data for debugging injection issues.
default String	getEncoderName()	Get the name of the encoder for the netty pipeline for this platform.
ProtocolVersion	getServerProtocolVersion()	Returns the server protocol version.
default SortedSet<ProtocolVersion>	getServerProtocolVersions()	Returns the supported server protocol versions.
void	inject()	Inject into the current Platform.
default boolean	lateProtocolVersionSetting()	Returns true if the protocol version cannot be used in the early init.
void	uninject()	Uninject into the current Platform.

Method Details

inject

void inject()
     throws Exception

Inject into the current Platform. May be empty on platforms not having to inject their pipeline or using alternative ways such as Mixin.

Throws:

Exception - if there is an error with injecting

uninject

void uninject()
       throws Exception

Uninject into the current Platform. May be empty on platforms not having to inject their pipeline or using alternative ways such as Mixin.

Throws:

Exception - if there is an error with uninjecting

lateProtocolVersionSetting

default boolean lateProtocolVersionSetting()

Returns true if the protocol version cannot be used in the early init. Namely, this returns true for forks of Vanilla without extra API to get the protocol version.

Returns:

true if the protocol version cannot be used in the early init

getServerProtocolVersion

ProtocolVersion getServerProtocolVersion()
                                  throws Exception

Returns the server protocol version. For proxies, this returns the lowest supported protocol version.

Returns:

server protocol version

Throws:

Exception - if there is an error with getting this info, e.g. not bound

See Also:

• ViaPlatform.isProxy()

getServerProtocolVersions

default SortedSet<ProtocolVersion> getServerProtocolVersions()
                                                      throws Exception

Returns the supported server protocol versions.

Returns:

server protocol versions

Throws:

Exception - if there is an error with getting this info, e.g. not bound

See Also:

• ViaPlatform.isProxy()

getEncoderName

default String getEncoderName()

Get the name of the encoder for the netty pipeline for this platform.

Returns:

The name

getDecoderName

default String getDecoderName()

Get the name of the decoder for the netty pipeline for this platform.

Returns:

The name

getDump

com.google.gson.JsonObject getDump()

Get any relevant data for debugging injection issues.

Returns:

JSONObject containing the data