Skip to main content

DataTransferer

Tsvrc.DataTransfer.DataTransferer is the end of the chain and the type you actually use. Its generated shadow is TsDataTransferer. Everything it does is inherited from DataChunker through DataSenderReceiver. Read those pages first if you haven't; this page only covers what DataTransferer itself adds. See Send a string payload to other players for a task-oriented walkthrough.

What it adds​

Four public event constants that simply forward DataSenderReceiver's reception-focused events under transfer-focused names (OnTransferStartedEvent, OnTransferStoppedEvent, OnTransferCompletedEvent, OnTransferChunkEvent), plus one small piece of defensive history: DataTransferer still overrides OnOwnerAbandonedProcess, but the override's body is now just a call to base. The base chain (ChunkedTransferSession's OnOwnerAbandonedProcess, inherited unchanged through DataSender, DataChunkReceiver, and DataSenderReceiver) already calls StopReadyCheck() and fully cleans up transfer state during a handover. The override exists to carry a comment warning against re-adding an earlier version's extra CancelDataTransfer() call here, which would run against an already-stopped process and log a spurious warning.

Getting an instance​

DataTransferer ships as one of TsVRC's own default pool entries (TsBuiltinConfig).

  • Default: a [WirePool] field of this type just resolves, nothing to register in Configure first. 
    [WirePool][SerializeField] private DataTransferer _transferer;
  • Manual: skip pooling entirely. Drag the shipped DataTransferer prefab into your scene (or AddComponent it) and call TsConstruct on it yourself, since nothing does that for an instance nobody registered anywhere. See Process for why skipping construction breaks ownership checks on anything this deep in the chain.

Usage​

transferer.TransferData(payload, targetPlayerIds);
transferer.TsSubscribe(this, TsDataTransferer.OnTransferCompletedEvent, nameof(OnTransferDone));
public void OnTransferDone()
{
    string received = transferer.LastData;
    // ...
}

LastPlayerIds (inherited from PlayerTracker, several layers down) is populated on OnTransferStarted/Stopped/Completed, carried over from the corresponding OnTracking* broadcast underneath. Read it if you need to know who the transfer targeted, alongside LastData, LastChunkIndex, and LastTotalChunks for the reception-specific details.

Where the real behavior lives​

Every failure mode worth knowing about, what happens when a target player leaves mid-transfer, what happens across an ownership handover, why chunks are validated the way they are, why events are deferred by a frame, is documented on the layer that actually implements it. Start from the chain overview if you're debugging something that doesn't match this page's description of the surface.