ReplayPlayer class
Play back the data that was recorded for a previous session by a ReplayRecorder.
Signature:
export declare class ReplayPlayer extends ExternalObject
Extends: ExternalObject
Remarks
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ReplayPlayer class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| completeEvent | readonly | O3hEvent<[]> | Triggered after the very last ReplayPlayer.timedEvent in the session is processed. |
| timedEvent | readonly | O3hEvent<readonly [ReplayEvent]> | Triggered with the data that was record at the same timer interval as during the recording session. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| destroy() | ||
| getAggregatedProperties() | Get all of the properties that have been aggregated across all plays of this module within the encompassing Oooh segment | |
| getEventCount() | The total number of replay events in the replay data | |
| getProperties() | Get all the properties for this replay. | |
| getRandomSeed() | The random seed that was used when generating data for this replay sequence. | |
| pause() | Pause the playback of this replay. | |
| reset() | Return the replay state back to it's initial state so you can call ReplayPlayer.start() against it again | |
| resume() | Resume the playback of this replay. | |
| start() | Start the playback of this replay. | |
| stop() | Stop the playback of this replay. |
ReplayPlayer.completeEvent property
Triggered after the very last ReplayPlayer.timedEvent in the session is processed.
Signature:
get completeEvent(): O3hEvent<[]>;
ReplayPlayer.destroy() method
Signature:
destroy(): void;
Returns:
void
ReplayPlayer.getAggregatedProperties() method
Get all of the properties that have been aggregated across all plays of this module within the encompassing Oooh segment
Signature:
getAggregatedProperties(): Promise<ReadonlyObjectMap<number>>;
Returns:
Promise<ReadonlyObjectMap<number>>
The replay properties saved by the replay recorder across all usage of the Oooh segment
ReplayPlayer.getEventCount() method
The total number of replay events in the replay data
Signature:
getEventCount(): Promise<number>;
Returns:
Promise<number>
A promise resolving to the total event count
ReplayPlayer.getProperties() method
Get all the properties for this replay.
Signature:
getProperties(): Promise<ReadonlyObjectMap<unknown>>;
Returns:
Promise<ReadonlyObjectMap<unknown>>
The replay properties as saved by the replay recorder.
ReplayPlayer.getRandomSeed() method
The random seed that was used when generating data for this replay sequence.
Signature:
getRandomSeed(): Promise<number>;
Returns:
Promise<number>
A promise resolving to the random seed number.
Remarks
The same seed should be used when using a random generator for any game play values during replay
ReplayPlayer.pause() method
Warning: This API is now obsolete.
Use ITimer.pause() instead
Pause the playback of this replay.
Signature:
pause(): void;
Returns:
void
ReplayPlayer.reset() method
Warning: This API is now obsolete.
Use ITimer.reset() instead
Return the replay state back to it's initial state so you can call ReplayPlayer.start() against it again
Signature:
reset(): void;
Returns:
void
ReplayPlayer.resume() method
Warning: This API is now obsolete.
Use ITimer.resume() instead
Resume the playback of this replay.
Signature:
resume(): void;
Returns:
void
ReplayPlayer.start() method
Warning: This API is now obsolete.
Use ITimer.start() instead
Start the playback of this replay.
Signature:
start(): void;
Returns:
void
ReplayPlayer.stop() method
Warning: This API is now obsolete.
Use ITimer.stop() instead
Stop the playback of this replay.
Signature:
stop(): void;
Returns:
void
ReplayPlayer.timedEvent property
Triggered with the data that was record at the same timer interval as during the recording session.
Signature:
get timedEvent(): O3hEvent<readonly [ReplayEvent]>;
Updated 10 months ago