net.malisis.core.util.syncer

Interface ISyncHandler<T,S extends ISyncableData>

Type Parameters:

T - the generic type

S - the generic type

All Known Implementing Classes:

DefaultSyncHandler, TileEntitySyncHandler

public interface ISyncHandler<T,S extends ISyncableData>

ISyncHandler are used to define handlers for the Syncer.
Handlers are created by factories registered through Syncer.registerHandlerFactory(String, com.google.common.base.Supplier).

Method Summary

Modifier and Type	Method and Description
void	addObjectData(ObjectData objectData) Adds a ObjectData to be handled by this ISyncHandler.
java.lang.String	getName() Gets the name of this ISyncHandler.
ObjectData	getObjectData(int index) Gets the ObjectData for the specified index (called from the the SyncerMessage.Packet).
ObjectData	getObjectData(java.lang.String name) Gets the ObjectData from its name.
T	getReceiver(net.minecraftforge.fml.common.network.simpleimpl.MessageContext ctx, S data) Gets the object to be synced on the receiving side.
S	getSyncData(T caller) Gets the ISyncableData that holds the extra data to be sent.
void	send(T caller, SyncerMessage.Packet<T,S> packet) Sends the syncing packet.

Method Detail

getName

java.lang.String getName()

Gets the name of this ISyncHandler. That name needs to match the Syncable value for the class it's applied on.

Returns:

the name

getReceiver

T getReceiver(net.minecraftforge.fml.common.network.simpleimpl.MessageContext ctx,
              S data)

Gets the object to be synced on the receiving side.

Parameters:

ctx - the ctx

data - the data

Returns:

the receiver

getSyncData

S getSyncData(T caller)

Gets the ISyncableData that holds the extra data to be sent.
On the receiving side, getSyncData() is called with a null caller, as the data is filled later by ISyncableData.fromBytes(io.netty.buffer.ByteBuf)

Parameters:

caller - the caller

Returns:

the sync data

addObjectData

void addObjectData(ObjectData objectData)

Adds a ObjectData to be handled by this ISyncHandler.

Parameters:

objectData - the field data

getObjectData

ObjectData getObjectData(int index)

Gets the ObjectData for the specified index (called from the the SyncerMessage.Packet).

Parameters:

index - the index

Returns:

the field data

getObjectData

ObjectData getObjectData(java.lang.String name)

Gets the ObjectData from its name.

Parameters:

name - the name

Returns:

the field data

send

void send(T caller,
          SyncerMessage.Packet<T,S> packet)

Sends the syncing packet.

Parameters:

caller - the caller

packet - the packet