Protocol (viaversion-api 4.8.1-SNAPSHOT API)

Type Parameters:

CU - unmapped clientbound packet types

CM - mapped clientbound packet types

SM - mapped serverbound packet types

SU - unmapped serverbound packet types

All Known Subinterfaces:

ProtocolPipeline, SimpleProtocol

All Known Implementing Classes:

AbstractProtocol, AbstractSimpleProtocol
```
public interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
```
Abstract protocol class handling packet transformation between two protocol versions. Clientbound and serverbount packet types can be set to enforce correct usage of them.

See Also:

for a helper class if you do not need to define any of the types above

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancelClientbound(CU packetType)` Cancels any clientbound packets from the given type.
`void`	`cancelClientbound(State state, int unmappedPacketId)`
`default void`	`cancelClientbound(State state, int unmappedPacketId, int mappedPacketId)` Deprecated. use `cancelClientbound(State, int)`
`void`	`cancelServerbound(State state, int mappedPacketId)`
`default void`	`cancelServerbound(State state, int unmappedPacketId, int mappedPacketId)` Deprecated. use `cancelServerbound(State, int)`
`void`	`cancelServerbound(SU packetType)` Cancels any serverbound packets from the given type.
`<T> T`	`get(java.lang.Class<T> objectClass)` Returns a cached object by the given type if present.
`default @Nullable EntityRewriter<?>`	`getEntityRewriter()` Returns the protocol's entity rewriter if present.
`default @Nullable ItemRewriter<?>`	`getItemRewriter()` Returns the protocol's item rewriter if present.
`default @Nullable MappingData`	`getMappingData()` Returns the protocol's mapping data if present.
`PacketTypesProvider<CU,CM,SM,SU>`	`getPacketTypesProvider()` Returns a packet type provider for this protocol to get packet types by id.
`default boolean`	`hasMappingDataToLoad()` Returns true if this Protocol's `loadMappingData()` method should be called.
`default boolean`	`hasRegisteredClientbound(CU packetType)` Checks if a clientbound packet has already been registered.
`boolean`	`hasRegisteredClientbound(State state, int unmappedPacketId)` Checks if a clientbound packet has already been registered.
`boolean`	`hasRegisteredServerbound(State state, int unmappedPacketId)` Checks if a serverbound packet has already been registered.
`default boolean`	`hasRegisteredServerbound(SU packetType)` Checks if a serverbound packet has already been registered.
`default void`	`init(UserConnection connection)` Initialise a user for this protocol setting up objects.
`void`	`initialize()` Called with `ProtocolManager.registerProtocol(com.viaversion.viaversion.api.protocol.Protocol, com.viaversion.viaversion.api.protocol.version.ProtocolVersion, com.viaversion.viaversion.api.protocol.version.ProtocolVersion)` to register packet handlers and automatic packet id remapping.
`default boolean`	`isBaseProtocol()` Returns whether this protocol is a base protocol.
`void`	`loadMappingData()` Loads the protocol's mapping data.
`void`	`put(java.lang.Object object)` Caches an object, retrievable by using `get(Class)`.
`default void`	`register(ViaProviders providers)` Handle protocol registration phase, use this to register providers / tasks.
`default void`	`registerClientbound(CU packetType, CM mappedPacketType)` Maps a packet type to another packet type without a packet handler.
`default void`	`registerClientbound(CU packetType, CM mappedPacketType, @Nullable PacketHandler handler)` Registers a clientbound packet mapping.
`void`	`registerClientbound(CU packetType, CM mappedPacketType, @Nullable PacketHandler handler, boolean override)` Registers a clientbound packet mapping.
`default void`	`registerClientbound(CU packetType, CM mappedPacketType, @Nullable PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerClientbound(CU packetType, CM mappedPacketType, @Nullable PacketRemapper packetRemapper, boolean override)` Deprecated.
`void`	`registerClientbound(CU packetType, @Nullable PacketHandler handler)` Registers a clientbound protocol and automatically maps it to the new id.
`default void`	`registerClientbound(CU packetType, @Nullable PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerClientbound(State state, int unmappedPacketId, int mappedPacketId)`
`default void`	`registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler)`
`void`	`registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)` Registers a clientbound packet, with id transformation and remapper.
`default void`	`registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketRemapper packetRemapper, boolean override)` Deprecated.
`default void`	`registerServerbound(State state, int unmappedPacketId, int mappedPacketId)`
`default void`	`registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler)`
`void`	`registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)` Registers a serverbound packet, with id transformation and remapper.
`default void`	`registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketRemapper packetRemapper, boolean override)` Deprecated.
`void`	`registerServerbound(SU packetType, @Nullable PacketHandler handler)` Registers a serverbound protocol and automatically maps it to the server's id.
`default void`	`registerServerbound(SU packetType, @Nullable PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerServerbound(SU packetType, SM mappedPacketType)` Maps a packet type to another packet type without a packet handler.
`default void`	`registerServerbound(SU packetType, SM mappedPacketType, @Nullable PacketHandler handler)` Registers a serverbound protocol.
`void`	`registerServerbound(SU packetType, SM mappedPacketType, @Nullable PacketHandler handler, boolean override)` Registers a serverbound packet mapping.
`default void`	`registerServerbound(SU packetType, SM mappedPacketType, @Nullable PacketRemapper packetRemapper)` Deprecated.
`default void`	`registerServerbound(SU packetType, SM mappedPacketType, @Nullable PacketRemapper packetRemapper, boolean override)` Deprecated.
`void`	`transform(Direction direction, State state, PacketWrapper packetWrapper)` Transform a packet using this protocol

Method Detail

registerServerbound

default void registerServerbound(State state,
                                 int unmappedPacketId,
                                 int mappedPacketId)

registerServerbound

default void registerServerbound(State state,
                                 int unmappedPacketId,
                                 int mappedPacketId,
                                 PacketHandler handler)

registerServerbound
```
void registerServerbound(State state,
                         int unmappedPacketId,
                         int mappedPacketId,
                         PacketHandler handler,
                         boolean override)
```
Registers a serverbound packet, with id transformation and remapper.

Parameters:

state - state which the packet is sent in.

unmappedPacketId - unmapped packet id

mappedPacketId - mapped packet id

handler - packet handler

override - whether an existing mapper should be overridden

See Also:

registerServerbound(ServerboundPacketType, ServerboundPacketType, PacketHandler, boolean)

cancelServerbound

void cancelServerbound(State state,
                       int mappedPacketId)

registerClientbound

default void registerClientbound(State state,
                                 int unmappedPacketId,
                                 int mappedPacketId)

registerClientbound

default void registerClientbound(State state,
                                 int unmappedPacketId,
                                 int mappedPacketId,
                                 PacketHandler handler)

cancelClientbound

void cancelClientbound(State state,
                       int unmappedPacketId)

registerClientbound
```
void registerClientbound(State state,
                         int unmappedPacketId,
                         int mappedPacketId,
                         PacketHandler handler,
                         boolean override)
```
Registers a clientbound packet, with id transformation and remapper.

Parameters:

state - state which the packet is sent in.

unmappedPacketId - unmapped packet id

mappedPacketId - mapped packet id

handler - packet handler

override - whether an existing mapper should be overridden

See Also:

registerClientbound(ClientboundPacketType, ClientboundPacketType, PacketHandler, boolean)

registerClientbound
```
void registerClientbound(CU packetType,
                         @Nullable PacketHandler handler)
```
Registers a clientbound protocol and automatically maps it to the new id.

Parameters:

packetType - clientbound packet type the server sends

handler - packet handler

registerClientbound
```
default void registerClientbound(CU packetType,
                                 CM mappedPacketType)
```
Maps a packet type to another packet type without a packet handler. Note that this should not be called for simple channel mappings of the same packet; this is already done automatically.

Parameters:

packetType - clientbound packet type the server initially sends

mappedPacketType - clientbound packet type after transforming for the client

registerClientbound
```
default void registerClientbound(CU packetType,
                                 CM mappedPacketType,
                                 @Nullable PacketHandler handler)
```
Registers a clientbound packet mapping.

Parameters:

packetType - clientbound packet type the server initially sends

mappedPacketType - clientbound packet type after transforming for the client

handler - packet handler

registerClientbound
```
void registerClientbound(CU packetType,
                         CM mappedPacketType,
                         @Nullable PacketHandler handler,
                         boolean override)
```
Registers a clientbound packet mapping.

Parameters:

packetType - clientbound packet type the server initially sends

mappedPacketType - clientbound packet type after transforming for the client

handler - packet handler

override - whether an existing mapping should be overridden if present

cancelClientbound
```
void cancelClientbound(CU packetType)
```
Cancels any clientbound packets from the given type.

Parameters:

packetType - clientbound packet type to cancel

registerServerbound
```
default void registerServerbound(SU packetType,
                                 SM mappedPacketType)
```
Maps a packet type to another packet type without a packet handler. Note that this should not be called for simple channel mappings of the same packet; this is already done automatically.

Parameters:

packetType - serverbound packet type the client initially sends

mappedPacketType - serverbound packet type after transforming for the client

registerServerbound
```
void registerServerbound(SU packetType,
                         @Nullable PacketHandler handler)
```
Registers a serverbound protocol and automatically maps it to the server's id.

Parameters:

packetType - serverbound packet type the client sends

handler - packet handler

registerServerbound
```
default void registerServerbound(SU packetType,
                                 SM mappedPacketType,
                                 @Nullable PacketHandler handler)
```
Registers a serverbound protocol.

Parameters:

packetType - serverbound packet type initially sent by the client

mappedPacketType - serverbound packet type after transforming for the server

handler - packet handler

registerServerbound
```
void registerServerbound(SU packetType,
                         SM mappedPacketType,
                         @Nullable PacketHandler handler,
                         boolean override)
```
Registers a serverbound packet mapping.

Parameters:

packetType - serverbound packet type initially sent by the client

mappedPacketType - serverbound packet type after transforming for the server

handler - packet handler

override - whether an existing mapping should be overridden if present

cancelServerbound
```
void cancelServerbound(SU packetType)
```
Cancels any serverbound packets from the given type.

Parameters:

packetType - serverbound packet type to cancel

hasRegisteredClientbound
```
default boolean hasRegisteredClientbound(CU packetType)
```
Checks if a clientbound packet has already been registered.

Parameters:

packetType - clientbound packet type

Returns:

true if already registered

hasRegisteredServerbound
```
default boolean hasRegisteredServerbound(SU packetType)
```
Checks if a serverbound packet has already been registered.

Parameters:

packetType - serverbound packet type

Returns:

true if already registered

hasRegisteredClientbound
```
boolean hasRegisteredClientbound(State state,
                                 int unmappedPacketId)
```
Checks if a clientbound packet has already been registered.

Parameters:

state - state which the packet is sent in

unmappedPacketId - unmapped packet id

Returns:

true if already registered

hasRegisteredServerbound
```
boolean hasRegisteredServerbound(State state,
                                 int unmappedPacketId)
```
Checks if a serverbound packet has already been registered.

Parameters:

state - state which the packet is sent in

unmappedPacketId - mapped packet id

Returns:

true if already registered

transform
```
void transform(Direction direction,
               State state,
               PacketWrapper packetWrapper)
        throws java.lang.Exception
```
Transform a packet using this protocol

Parameters:

direction - The direction the packet is going in

state - The current protocol state

packetWrapper - The packet wrapper to transform

Throws:

java.lang.Exception - Throws exception if it fails to transform

getPacketTypesProvider
```
@Beta
PacketTypesProvider<CU,CM,SM,SU> getPacketTypesProvider()
```
Returns a packet type provider for this protocol to get packet types by id. Depending on the Protocol, not every state may be populated.

Returns:

the packet types provider

get
```
<T> T get(java.lang.Class<T> objectClass)
```
Returns a cached object by the given type if present.

Type Parameters:

T - type

Parameters:

objectClass - class of the object to get

Returns:

object if present, else null

put
```
void put(java.lang.Object object)
```
Caches an object, retrievable by using get(Class).

Parameters:

object - object to cache

initialize
```
void initialize()
```
Called with ProtocolManager.registerProtocol(com.viaversion.viaversion.api.protocol.Protocol, com.viaversion.viaversion.api.protocol.version.ProtocolVersion, com.viaversion.viaversion.api.protocol.version.ProtocolVersion) to register packet handlers and automatic packet id remapping.

Throws:

java.lang.IllegalArgumentException - if this method has already been called

hasMappingDataToLoad
```
default boolean hasMappingDataToLoad()
```
Returns true if this Protocol's loadMappingData() method should be called.
This does *not* necessarily mean that getMappingData() is non-null, since this may be overriden, depending on special cases.

Returns:

true if this Protocol's loadMappingData() method should be called

loadMappingData
```
void loadMappingData()
```
Loads the protocol's mapping data.

Throws:

java.lang.NullPointerException - if this protocol has no mapping data

register
```
default void register(ViaProviders providers)
```
Handle protocol registration phase, use this to register providers / tasks.
To be overridden if needed.

Parameters:

providers - The current providers

init
```
default void init(UserConnection connection)
```
Initialise a user for this protocol setting up objects. /!\ WARNING - May be called more than once in a single UserConnection
To be overridden if needed.

Parameters:

connection - user to initialise

getMappingData
```
default @Nullable MappingData getMappingData()
```
Returns the protocol's mapping data if present.

Returns:

mapping data if present

getEntityRewriter
```
default @Nullable EntityRewriter<?> getEntityRewriter()
```
Returns the protocol's entity rewriter if present.

Returns:

entity rewriter

getItemRewriter
```
default @Nullable ItemRewriter<?> getItemRewriter()
```
Returns the protocol's item rewriter if present.

Returns:

item rewriter

isBaseProtocol
```
default boolean isBaseProtocol()
```
Returns whether this protocol is a base protocol.

Returns:

whether this represents a base protocol

cancelServerbound

@Deprecated
default void cancelServerbound(State state,
                                           int unmappedPacketId,
                                           int mappedPacketId)

Deprecated. use cancelServerbound(State, int)

cancelClientbound

@Deprecated
default void cancelClientbound(State state,
                                           int unmappedPacketId,
                                           int mappedPacketId)

Deprecated. use cancelClientbound(State, int)

registerClientbound

@Deprecated
default void registerClientbound(State state,
                                             int unmappedPacketId,
                                             int mappedPacketId,
                                             PacketRemapper packetRemapper)

Deprecated.

registerClientbound

@Deprecated
default void registerClientbound(State state,
                                             int unmappedPacketId,
                                             int mappedPacketId,
                                             PacketRemapper packetRemapper,
                                             boolean override)

Deprecated.

registerClientbound

@Deprecated
default void registerClientbound(CU packetType,
                                             @Nullable PacketRemapper packetRemapper)

Deprecated.

registerClientbound

@Deprecated
default void registerClientbound(CU packetType,
                                             CM mappedPacketType,
                                             @Nullable PacketRemapper packetRemapper)

Deprecated.

registerClientbound

@Deprecated
default void registerClientbound(CU packetType,
                                             CM mappedPacketType,
                                             @Nullable PacketRemapper packetRemapper,
                                             boolean override)

Deprecated.

registerServerbound

@Deprecated
default void registerServerbound(State state,
                                             int unmappedPacketId,
                                             int mappedPacketId,
                                             PacketRemapper packetRemapper)

Deprecated.

registerServerbound

@Deprecated
default void registerServerbound(State state,
                                             int unmappedPacketId,
                                             int mappedPacketId,
                                             PacketRemapper packetRemapper,
                                             boolean override)

Deprecated.

registerServerbound

@Deprecated
default void registerServerbound(SU packetType,
                                             @Nullable PacketRemapper packetRemapper)

Deprecated.

registerServerbound

@Deprecated
default void registerServerbound(SU packetType,
                                             SM mappedPacketType,
                                             @Nullable PacketRemapper packetRemapper)

Deprecated.

registerServerbound

@Deprecated
default void registerServerbound(SU packetType,
                                             SM mappedPacketType,
                                             @Nullable PacketRemapper packetRemapper,
                                             boolean override)

Deprecated.

Interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>

Method Summary

Method Detail

registerServerbound

registerServerbound

registerServerbound

cancelServerbound

registerClientbound

registerClientbound

cancelClientbound

registerClientbound

registerClientbound

registerClientbound

registerClientbound

registerClientbound

cancelClientbound

registerServerbound

registerServerbound

registerServerbound

registerServerbound

cancelServerbound

hasRegisteredClientbound

hasRegisteredServerbound

hasRegisteredClientbound

hasRegisteredServerbound

transform

getPacketTypesProvider

get

put

initialize

hasMappingDataToLoad

loadMappingData

register

init

getMappingData

getEntityRewriter

getItemRewriter

isBaseProtocol

cancelServerbound

cancelClientbound

registerClientbound

registerClientbound

registerClientbound

registerClientbound

registerClientbound

registerServerbound

registerServerbound

registerServerbound

registerServerbound

registerServerbound