us.myles.ViaVersion.api.rewriters

Class MetadataRewriter

java.lang.Object

us.myles.ViaVersion.api.rewriters.MetadataRewriter

Direct Known Subclasses:

MetadataRewriter1_11To1_10, MetadataRewriter1_12To1_11_1, MetadataRewriter1_13_1To1_13, MetadataRewriter1_13To1_12_2, MetadataRewriter1_14_1To1_14, MetadataRewriter1_14To1_13_2, MetadataRewriter1_15To1_14_4, MetadataRewriter1_16_2To1_16_1, MetadataRewriter1_16To1_15_2, MetadataRewriter1_9To1_8

public abstract class MetadataRewriter
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Protocol	protocol

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataRewriter(Protocol protocol, Class<? extends EntityTracker> entityTrackerClass)

Method Summary

Modifier and Type	Method and Description
protected @Nullable Metadata	getMetaByIndex(int index, List<Metadata> metadataList)
int	getNewEntityId(int oldId) Returns the mapped entitiy (or the same if it has not changed).
PacketHandler	getObjectTracker() Returns a packethandler to track an object entity.
protected EntityType	getObjectTypeFromId(int type) Returns the entity type from the given id.
PacketHandler	getTracker()
PacketHandler	getTrackerAndRewriter(@Nullable Type<List<Metadata>> metaType) Returns a packethandler to track and rewrite an entity.
PacketHandler	getTrackerAndRewriter(@Nullable Type<List<Metadata>> metaType, EntityType entityType)
protected abstract EntityType	getTypeFromId(int type)
protected abstract void	handleMetadata(int entityId, @Nullable EntityType type, Metadata metadata, List<Metadata> metadatas, UserConnection connection) To be overridden to handle metadata.
void	handleMetadata(int entityId, List<Metadata> metadatas, UserConnection connection)
void	mapType(EntityType oldType, EntityType newType)
<T extends Enum<T> & EntityType> void	mapTypes(EntityType[] oldTypes, Class<T> newTypeClass)
void	registerEntityDestroy(ClientboundPacketType packetType)
void	registerMetadataRewriter(ClientboundPacketType packetType, Type<List<Metadata>> metaType)
void	registerMetadataRewriter(ClientboundPacketType packetType, @Nullable Type<List<Metadata>> oldMetaType, Type<List<Metadata>> newMetaType)
void	registerSpawnTrackerWithData(ClientboundPacketType packetType, EntityType fallingBlockType)
void	registerTracker(ClientboundPacketType packetType)
void	registerTracker(ClientboundPacketType packetType, EntityType entityType)
protected void	rewriteParticle(Particle particle)

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected final Protocol protocol

Constructor Detail

MetadataRewriter

protected MetadataRewriter(Protocol protocol,
                           Class<? extends EntityTracker> entityTrackerClass)

Method Detail

handleMetadata

public final void handleMetadata(int entityId,
                                 List<Metadata> metadatas,
                                 UserConnection connection)

rewriteParticle

protected void rewriteParticle(Particle particle)

registerTracker

public void registerTracker(ClientboundPacketType packetType)

registerSpawnTrackerWithData

public void registerSpawnTrackerWithData(ClientboundPacketType packetType,
                                         EntityType fallingBlockType)

registerTracker

public void registerTracker(ClientboundPacketType packetType,
                            EntityType entityType)

registerEntityDestroy

public void registerEntityDestroy(ClientboundPacketType packetType)

registerMetadataRewriter

public void registerMetadataRewriter(ClientboundPacketType packetType,
                                     @Nullable
                                     @Nullable Type<List<Metadata>> oldMetaType,
                                     Type<List<Metadata>> newMetaType)

registerMetadataRewriter

public void registerMetadataRewriter(ClientboundPacketType packetType,
                                     Type<List<Metadata>> metaType)

mapTypes

public <T extends Enum<T> & EntityType> void mapTypes(EntityType[] oldTypes,
                                                      Class<T> newTypeClass)

mapType

public void mapType(EntityType oldType,
                    EntityType newType)

getTracker

public PacketHandler getTracker()

getTrackerAndRewriter

public PacketHandler getTrackerAndRewriter(@Nullable
                                           @Nullable Type<List<Metadata>> metaType)

Returns a packethandler to track and rewrite an entity.

Parameters:

metaType - type of the metadata list

Returns:

handler for tracking and rewriting entities

getTrackerAndRewriter

public PacketHandler getTrackerAndRewriter(@Nullable
                                           @Nullable Type<List<Metadata>> metaType,
                                           EntityType entityType)

getObjectTracker

public PacketHandler getObjectTracker()

Returns a packethandler to track an object entity.

Returns:

handler for tracking and rewriting entities

getTypeFromId

protected abstract EntityType getTypeFromId(int type)

getObjectTypeFromId

protected EntityType getObjectTypeFromId(int type)

Returns the entity type from the given id. From 1.14 and onwards, this is the same exact value as getTypeFromId(int).

Parameters:

type - entity type id

Returns:

EntityType from id

getNewEntityId

public int getNewEntityId(int oldId)

Returns the mapped entitiy (or the same if it has not changed).

Parameters:

oldId - old entity id

Returns:

mapped entity id

handleMetadata

protected abstract void handleMetadata(int entityId,
                                       @Nullable
                                       @Nullable EntityType type,
                                       Metadata metadata,
                                       List<Metadata> metadatas,
                                       UserConnection connection)
                                throws Exception

To be overridden to handle metadata.

Parameters:

entityId - entity id

type - entity type, or null if not tracked

metadata - current metadata

metadatas - full, mutable list of metadata

connection - user connection

Throws:

Exception

getMetaByIndex

@Nullable
protected @Nullable Metadata getMetaByIndex(int index,
                                                      List<Metadata> metadataList)