us.myles.ViaVersion.protocols.base

Class BaseProtocol

java.lang.Object

us.myles.ViaVersion.api.protocol.Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

us.myles.ViaVersion.api.protocol.SimpleProtocol

us.myles.ViaVersion.protocols.base.BaseProtocol

public class BaseProtocol
extends SimpleProtocol

Nested Class Summary

Nested classes/interfaces inherited from class us.myles.ViaVersion.api.protocol.SimpleProtocol

SimpleProtocol.DummyPacketTypes

Nested classes/interfaces inherited from class us.myles.ViaVersion.api.protocol.Protocol

Protocol.Packet, Protocol.ProtocolPacket

Field Summary

Fields inherited from class us.myles.ViaVersion.api.protocol.Protocol

newClientboundPacketEnum, newServerboundPacketEnum, oldClientboundPacketEnum, oldServerboundPacketEnum

Constructor Summary

Constructors

Constructor and Description
BaseProtocol()

Method Summary

Modifier and Type	Method and Description
void	init(UserConnection userConnection) Initialise a user for this protocol setting up objects.
protected void	register(ViaProviders providers) Handle protocol registration phase, use this to register providers / tasks.
protected void	registerPackets() Register the packets for this protocol.
void	transform(Direction direction, State state, PacketWrapper packetWrapper) Transform a packet using this protocol

Methods inherited from class us.myles.ViaVersion.api.protocol.Protocol

cancelIncoming, cancelIncoming, cancelIncoming, cancelOutgoing, cancelOutgoing, cancelOutgoing, filterPacket, get, getMappingData, hasMappingDataToLoad, hasRegisteredIncoming, hasRegisteredOutgoing, isFiltered, loadMappingData, onMappingDataLoaded, put, registerIncoming, registerIncoming, registerIncoming, registerIncoming, registerIncoming, registerIncomingChannelIdChanges, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoingChannelIdChanges, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseProtocol

public BaseProtocol()

Method Detail

registerPackets

protected void registerPackets()

Description copied from class: Protocol

Register the packets for this protocol. To be overriden.

Overrides:

registerPackets in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

init

public void init(UserConnection userConnection)

Description copied from class: Protocol

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.

Overrides:

init in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

Parameters:

userConnection - The user to initialise

register

protected void register(ViaProviders providers)

Description copied from class: Protocol

Handle protocol registration phase, use this to register providers / tasks.

To be overridden if needed.

Overrides:

register in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

Parameters:

providers - The current providers

transform

public void transform(Direction direction,
                      State state,
                      PacketWrapper packetWrapper)
               throws Exception

Description copied from class: Protocol

Transform a packet using this protocol

Overrides:

transform in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

Parameters:

direction - The direction the packet is going in

state - The current protocol state

packetWrapper - The packet wrapper to transform

Throws:

Exception - Throws exception if it fails to transform