ReplaySnapshot Class
From Ultimate Replay
Ultimate Replay Scripting Reference
| ReplaySnapshot Class |
A frame state is a snapshot of a replay frame that is indexed based on its time stamp.
By sequencing multiple frame states you can create the replay effect.
Inheritance HierarchyNamespace: UltimateReplay.Storage
Assembly: UltimateReplay (in UltimateReplay.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public sealed class ReplaySnapshot : IReplaySerialize, IReplayDataSerialize
The ReplaySnapshot type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReplaySnapshot |
Create a new snapshot with the specified time stamp.
|
Methods| Name | Description | |
|---|---|---|
| OnReplayDataDeserialize |
Called by the replay system when this ReplaySnapshot should be deserialized from binary.
|
| OnReplayDataSerialize |
Called by the replay system when this ReplaySnapshot should be serialized to binary.
|
| OnReplayDeserialize |
Called by the replay system when this ReplaySnapshot should be deserialized.
|
| OnReplaySerialize |
Called by the replay system when this ReplaySnapshot should be serialized.
|
| RecordInitialReplayObjectData |
Attempts to record the initial information about a newly created replay object.
The initial information will only be sroted if the data is not equal to the default value.
|
| RecordSnapshot |
Registers the specified replay state with this snapshot.
The specified identity is used during playback to ensure that the replay objects receives the correct state to deserialize.
|
| Reset |
Clears all state information from the snapshot but keeps the time stamp.
|
| RestoreInitialReplayObjectData |
Attempts to get the initial data for the replay object with the specified ReplayIdentity.
A ReplayInitialData will be returned containing the initial state for the replay object.
|
| RestoreReplayObjects |
Attempts to restore any replay objects that were spawned or despawned during this snapshot.
|
| RestoreSnapshot |
Attempts to recall the state information for the specified replay object identity.
If the identity does not exist in the scene then the return value will be null.
|
Properties| Name | Description | |
|---|---|---|
 | Size |
Get the size in bytes of the snapshot data.
|
| TimeStamp |
The time stamp for this snapshot.
The time stamp is used to identify the snapshot location in the sequence.
|
See Also