Interface: PlayerDataSnapshotInfo<T>

Information accompanying a complete player-data snapshot.

Extends

Type Parameters

T

T = SyncedObject

Properties

affects

readonly affects: (playerId, ...path) => boolean

Returns whether this snapshot invalidates a path in one player's data. Initial snapshots and recovery replacements affect every path for every player present in the snapshot. An unknown or invalid player ID returns false.

Parameters

playerId

number

path

...SyncedObjectPath

Returns

boolean


change?

readonly optional change?: PlayerDataChangedEvent<T>

The accepted change as represented through this view when this was an ordinary Player Data change. It is absent for SnapshotReason.Initial, SnapshotReason.Resync, and data installed by a join or rejoin.


reason

readonly reason: SnapshotReason

Why Plot delivered this complete snapshot.

Inherited from

SnapshotInfo.reason