java.lang.Object

com.viaversion.viaversion.api.protocol.AbstractProtocol<CU,CM,SM,SU>

Type Parameters:: CU - unmapped clientbound packet type; CM - mapped clientbound packet type; SM - mapped serverbound packet type; SU - unmapped serverbound packet type

All Implemented Interfaces:: Protocol<CU,CM,SM,SU>

Direct Known Subclasses:: AbstractSimpleProtocol

public abstract class AbstractProtocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType> extends Object implements Protocol<CU,CM,SM,SU>

Abstract protocol class to handle packet transformation between two protocol versions.

Field Summary

Fields

Modifier and Type

Field

Description

protected final PacketMappings

clientboundMappings

protected final Class<CM>

mappedClientboundPacketType

protected final Class<SM>

mappedServerboundPacketType

protected final PacketTypesProvider<CU,CM,SM,SU>

packetTypesProvider

protected final PacketMappings

serverboundMappings

protected final Class<CU>

unmappedClientboundPacketType

protected final Class<SU>

unmappedServerboundPacketType
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AbstractProtocol()

Deprecated.

protected

AbstractProtocol(@Nullable Class<CU> unmappedClientboundPacketType, @Nullable Class<CM> mappedClientboundPacketType, @Nullable Class<SM> mappedServerboundPacketType, @Nullable Class<SU> unmappedServerboundPacketType)

Creates a protocol with automated id mapping if the respective packet type classes are not null.
Method Summary

Modifier and Type

Method

Description

protected void

addEntityTracker(UserConnection connection, EntityTracker tracker)

void

appendClientbound(CU type, PacketHandler handler)

Appends a clientbound packet type handler with another, as opposed to replacing it entirely.

void

appendServerbound(SU type, PacketHandler handler)

Appends a serverbound packet type handler with another, as opposed to replacing it entirely.

void

cancelClientbound(State state, int unmappedPacketId)

void

cancelClientbound(CU packetType)

Cancels any clientbound packets from the given type.

void

cancelServerbound(State state, int unmappedPacketId)

void

cancelServerbound(SU packetType)

Cancels any serverbound packets from the given type.

protected @Nullable CU

clientboundFinishConfigurationPacket()

protected @Nullable SU

configurationAcknowledgedPacket()

protected PacketMappings

createClientboundPacketMappings()

protected PacketTypesProvider<CU,CM,SM,SU>

createPacketTypesProvider()

protected PacketMappings

createServerboundPacketMappings()

<T> @Nullable T

get(Class<T> objectClass)

Returns a cached object by the given type if present.

ProtocolLogger

getLogger()

Returns the protocol's logger.

final PacketTypesProvider<CU,CM,SM,SU>

getPacketTypesProvider()

Returns a packet type provider for this protocol to get packet types by id.

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.

final 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.

final void

loadMappingData()

Loads the protocol's mapping data.

protected void

onMappingDataLoaded()

Called after loadMappingData() is called; load extra mapping data for the protocol.

void

put(Object object)

Caches an object, retrievable by using Protocol.get(Class).

void

registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)

Registers a clientbound packet, with id transformation and remapper.

void

registerClientbound(CU packetType, @Nullable CM mappedPacketType, @Nullable PacketHandler handler, boolean override)

Registers a clientbound packet mapping.

void

registerClientbound(CU packetType, @Nullable PacketHandler handler)

Registers a clientbound protocol and automatically maps it to the new id.

protected void

registerConfigurationChangeHandlers()

protected void

registerPackets()

Register the packets for this protocol.

void

registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)

Registers a serverbound packet, with id transformation and remapper.

void

registerServerbound(SU packetType, @Nullable PacketHandler handler)

Registers a serverbound protocol and automatically maps it to the server's id.

void

registerServerbound(SU packetType, @Nullable SM mappedPacketType, @Nullable PacketHandler handler, boolean override)

Registers a serverbound packet mapping.

protected @Nullable SU

serverboundFinishConfigurationPacket()

protected @Nullable CU

startConfigurationPacket()

String

toString()

void

transform(Direction direction, State state, PacketWrapper packetWrapper)

Transform a packet using this protocol

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.viaversion.viaversion.api.protocol.Protocol
getComponentRewriter, getEntityRewriter, getItemRewriter, getMappingData, getTagRewriter, hasMappingDataToLoad, hasRegisteredClientbound, hasRegisteredServerbound, init, isBaseProtocol, register, registerClientbound, registerClientbound, registerClientbound, registerClientbound, registerServerbound, registerServerbound, registerServerbound, registerServerbound

Field Details
- unmappedClientboundPacketType
  
  protected final Class<CU extends ClientboundPacketType> unmappedClientboundPacketType
- mappedClientboundPacketType
  
  protected final Class<CM extends ClientboundPacketType> mappedClientboundPacketType
- mappedServerboundPacketType
  
  protected final Class<SM extends ServerboundPacketType> mappedServerboundPacketType
- unmappedServerboundPacketType
  
  protected final Class<SU extends ServerboundPacketType> unmappedServerboundPacketType
- packetTypesProvider
  
  protected final PacketTypesProvider<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType> packetTypesProvider
- clientboundMappings
  
  protected final PacketMappings clientboundMappings
- serverboundMappings
  
  protected final PacketMappings serverboundMappings
Constructor Details
- AbstractProtocol
  
  @Deprecated protected AbstractProtocol()
  
  Deprecated.
- AbstractProtocol
  
  protected AbstractProtocol(@Nullable Class<CU> unmappedClientboundPacketType, @Nullable Class<CM> mappedClientboundPacketType, @Nullable Class<SM> mappedServerboundPacketType, @Nullable Class<SU> unmappedServerboundPacketType)
  
  Creates a protocol with automated id mapping if the respective packet type classes are not null. They are also required to track the CONFIGURATION state.
Method Details
- initialize
  
  public final void initialize()
  
  Description copied from interface: Protocol
  
  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.
  
  Specified by:
  
  initialize in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
- registerConfigurationChangeHandlers
  
  protected void registerConfigurationChangeHandlers()
- appendClientbound
  
  public void appendClientbound(CU type, PacketHandler handler)
  
  Description copied from interface: Protocol
  
  Appends a clientbound packet type handler with another, as opposed to replacing it entirely.
  Use PacketWrapper.set(Type, int, Object) to change individual parts, or call PacketWrapper.resetReader() to reset the reader index.
  
  Specified by:
  
  appendClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  type - clientbound packet type
  
  handler - packet handler
- appendServerbound
  
  public void appendServerbound(SU type, PacketHandler handler)
  
  Description copied from interface: Protocol
  
  Appends a serverbound packet type handler with another, as opposed to replacing it entirely.
  Use PacketWrapper.set(Type, int, Object) to change individual parts, or call PacketWrapper.resetReader() to reset the reader index.
  
  Specified by:
  
  appendServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  type - serverbound packet type
  
  handler - packet handler
- loadMappingData
  
  public final void loadMappingData()
  
  Description copied from interface: Protocol
  
  Loads the protocol's mapping data.
  
  Specified by:
  
  loadMappingData in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
- registerPackets
  
  protected void registerPackets()
  
  Register the packets for this protocol. To be overriden.
- onMappingDataLoaded
  
  protected void onMappingDataLoaded()
  
  Called after loadMappingData() is called; load extra mapping data for the protocol.
  To be overridden if needed.
- addEntityTracker
  
  protected void addEntityTracker(UserConnection connection, EntityTracker tracker)
- createPacketTypesProvider
  
  protected PacketTypesProvider<CU,CM,SM,SU> createPacketTypesProvider()
- createClientboundPacketMappings
  
  protected PacketMappings createClientboundPacketMappings()
- createServerboundPacketMappings
  
  protected PacketMappings createServerboundPacketMappings()
- configurationAcknowledgedPacket
  
  protected @Nullable SU configurationAcknowledgedPacket()
- startConfigurationPacket
  
  protected @Nullable CU startConfigurationPacket()
- serverboundFinishConfigurationPacket
  
  protected @Nullable SU serverboundFinishConfigurationPacket()
- clientboundFinishConfigurationPacket
  
  protected @Nullable CU clientboundFinishConfigurationPacket()
- registerServerbound
  
  public void registerServerbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)
  
  Description copied from interface: Protocol
  
  Registers a serverbound packet, with id transformation and remapper.
  Specified by:
  
  registerServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  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:
  
  Protocol.registerServerbound(ServerboundPacketType, ServerboundPacketType, PacketHandler, boolean)
- cancelServerbound
  
  public void cancelServerbound(State state, int unmappedPacketId)
  
  Specified by:
  
  cancelServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
- registerClientbound
  
  public void registerClientbound(State state, int unmappedPacketId, int mappedPacketId, PacketHandler handler, boolean override)
  
  Description copied from interface: Protocol
  
  Registers a clientbound packet, with id transformation and remapper.
  Specified by:
  
  registerClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  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:
  
  Protocol.registerClientbound(ClientboundPacketType, ClientboundPacketType, PacketHandler, boolean)
- cancelClientbound
  
  public void cancelClientbound(State state, int unmappedPacketId)
  
  Specified by:
  
  cancelClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
- registerClientbound
  
  public void registerClientbound(CU packetType, @Nullable PacketHandler handler)
  
  Description copied from interface: Protocol
  
  Registers a clientbound protocol and automatically maps it to the new id.
  
  Specified by:
  
  registerClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  packetType - clientbound packet type the server sends
  
  handler - packet handler
- registerClientbound
  
  public void registerClientbound(CU packetType, @Nullable CM mappedPacketType, @Nullable PacketHandler handler, boolean override)
  
  Description copied from interface: Protocol
  
  Registers a clientbound packet mapping.
  
  Specified by:
  
  registerClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  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
  
  public void cancelClientbound(CU packetType)
  
  Description copied from interface: Protocol
  
  Cancels any clientbound packets from the given type.
  
  Specified by:
  
  cancelClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  packetType - clientbound packet type to cancel
- registerServerbound
  
  public void registerServerbound(SU packetType, @Nullable PacketHandler handler)
  
  Description copied from interface: Protocol
  
  Registers a serverbound protocol and automatically maps it to the server's id.
  
  Specified by:
  
  registerServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  packetType - serverbound packet type the client sends
  
  handler - packet handler
- registerServerbound
  
  public void registerServerbound(SU packetType, @Nullable SM mappedPacketType, @Nullable PacketHandler handler, boolean override)
  
  Description copied from interface: Protocol
  
  Registers a serverbound packet mapping.
  
  Specified by:
  
  registerServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  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
  
  public void cancelServerbound(SU packetType)
  
  Description copied from interface: Protocol
  
  Cancels any serverbound packets from the given type.
  
  Specified by:
  
  cancelServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  packetType - serverbound packet type to cancel
- hasRegisteredClientbound
  
  public boolean hasRegisteredClientbound(State state, int unmappedPacketId)
  
  Description copied from interface: Protocol
  
  Checks if a clientbound packet has already been registered.
  
  Specified by:
  
  hasRegisteredClientbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  state - state which the packet is sent in
  
  unmappedPacketId - unmapped packet id
  
  Returns:
  
  true if already registered
- hasRegisteredServerbound
  
  public boolean hasRegisteredServerbound(State state, int unmappedPacketId)
  
  Description copied from interface: Protocol
  
  Checks if a serverbound packet has already been registered.
  
  Specified by:
  
  hasRegisteredServerbound in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  state - state which the packet is sent in
  
  unmappedPacketId - mapped packet id
  
  Returns:
  
  true if already registered
- transform
  
  public void transform(Direction direction, State state, PacketWrapper packetWrapper) throws InformativeException, CancelException
  
  Description copied from interface: Protocol
  
  Transform a packet using this protocol
  
  Specified by:
  
  transform in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  direction - The direction the packet is going in
  
  state - The current protocol state
  
  packetWrapper - The packet wrapper to transform
  
  Throws:
  
  InformativeException
  
  CancelException
- getLogger
  
  public ProtocolLogger getLogger()
  
  Description copied from interface: Protocol
  
  Returns the protocol's logger.
  
  Specified by:
  
  getLogger in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Returns:
  
  logger
- getPacketTypesProvider
  
  public final PacketTypesProvider<CU,CM,SM,SU> getPacketTypesProvider()
  
  Description copied from interface: Protocol
  
  Returns a packet type provider for this protocol to get packet types by id. Depending on the Protocol, not every state may be populated.
  
  Specified by:
  
  getPacketTypesProvider in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Returns:
  
  the packet types provider
- get
  
  public <T> @Nullable T get(Class<T> objectClass)
  
  Description copied from interface: Protocol
  
  Returns a cached object by the given type if present.
  
  Specified by:
  
  get in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Type Parameters:
  
  T - type
  
  Parameters:
  
  objectClass - class of the object to get
  
  Returns:
  
  object if present, else null
- put
  
  public void put(Object object)
  
  Description copied from interface: Protocol
  
  Caches an object, retrievable by using Protocol.get(Class).
  
  Specified by:
  
  put in interface Protocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>
  
  Parameters:
  
  object - object to cache
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object

Class AbstractProtocol<CU extends ClientboundPacketType,CM extends ClientboundPacketType,SM extends ServerboundPacketType,SU extends ServerboundPacketType>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.viaversion.viaversion.api.protocol.Protocol

Field Details

unmappedClientboundPacketType

mappedClientboundPacketType

mappedServerboundPacketType

unmappedServerboundPacketType

packetTypesProvider

clientboundMappings

serverboundMappings

Constructor Details

AbstractProtocol

AbstractProtocol

Method Details

initialize

registerConfigurationChangeHandlers

appendClientbound

appendServerbound

loadMappingData

registerPackets

onMappingDataLoaded

addEntityTracker

createPacketTypesProvider

createClientboundPacketMappings

createServerboundPacketMappings

configurationAcknowledgedPacket

startConfigurationPacket

serverboundFinishConfigurationPacket

clientboundFinishConfigurationPacket

registerServerbound

cancelServerbound

registerClientbound

cancelClientbound

registerClientbound

registerClientbound

cancelClientbound

registerServerbound

registerServerbound

cancelServerbound

hasRegisteredClientbound

hasRegisteredServerbound

transform

getLogger

getPacketTypesProvider

get

put

toString