registry_serialization Namespace Reference

Utilities for serializing and deserializing the ECS registry over the network. More...

Classes
struct	RemoteInputRecord
	A paired entity ID and input snapshot received from a remote client. More...
class	Loader
	Deserializes registry snapshots received from the server and applies them locally. More...

Typedefs
using	Synced

Functions
std::vector< uint8_t >	encodeDelta (const std::vector< uint8_t > &baseline, const std::vector< uint8_t > &current)
	Compute an RLE byte-diff patch from baseline to current.
std::vector< uint8_t >	applyDelta (const std::vector< uint8_t > &baseline, const uint8_t *patch, std::size_t patchSize, std::size_t outputSize)
	Reconstruct current from baseline + patch.
std::vector< uint8_t >	serialize (const entt::registry &registry)
	Serialize the full registry state into a byte buffer for transmission.

Detailed Description

Utilities for serializing and deserializing the ECS registry over the network.

Typedef Documentation

Synced

using registry_serialization::Synced

Initial value:

std::tuple<entt::entity,
                         Position,
                         Velocity,
                         PlayerVisState,
                         CollisionShape,
                         WeaponState,
                         GrenadeState,
                         Health,
                         AbilityState,
                         PlayerMatchStats,
                         Projectile,
                         BeamState,
                         ClientId,
                         DeathInfo,
                         RespawnTimer,
                         Orientation,
                         RagdollBoneTag,
                         WeaponSpawner,
                         DroppedWeapon,
                         RespawnPoint,
                         AnimSnapshot,
                         FireField,
                         PlayerColor,
                         PlayerName,
                         PowerupSpawner,
                         HealthPackSpawner>

Function Documentation

applyDelta()

std::vector< uint8_t > registry_serialization::applyDelta	(	const std::vector< uint8_t > &	baseline,
		const uint8_t *	patch,
		std::size_t	patchSize,
		std::size_t	outputSize )

Reconstruct current from baseline + patch.

Parameters

baseline	Receiver's stored baseline (size must match outputSize).
patch	The bytes returned by a prior encodeDelta.
outputSize	Expected size of the reconstructed buffer (passed on the wire as the third u32 of the delta header).

Returns

Reconstructed buffer of size outputSize, or empty on parse error (truncated patch, malformed offsets).

Here is the caller graph for this function:

encodeDelta()

std::vector< uint8_t > registry_serialization::encodeDelta	(	const std::vector< uint8_t > &	baseline,
		const std::vector< uint8_t > &	current )

Compute an RLE byte-diff patch from baseline to current.

Both buffers MUST have the same size; the returned patch reconstructs current from a copy of baseline via applyDelta. The patch is always smaller than current only when many bytes are unchanged; callers should compare patch size to full size before sending.

Parameters

baseline	Bytes the receiver currently holds.
current	Bytes the receiver should arrive at.

Returns

Patch bytes (possibly empty if both inputs are byte-identical).

Here is the caller graph for this function:

serialize()

std::vector< uint8_t > registry_serialization::serialize

(

const entt::registry &

registry

)

Serialize the full registry state into a byte buffer for transmission.

Parameters

registry

The source ECS registry.

Returns

A byte vector containing the serialized snapshot.

Here is the call graph for this function:

Here is the caller graph for this function: