Quantum 3 3.0.13

Public Member Functions | Properties | List of all members
Photon.Deterministic.IDeterministicStreamReplayInputProvider Interface Reference

The interface to implement streaming input for a Quantum replay session. More...

Inheritance diagram for Photon.Deterministic.IDeterministicStreamReplayInputProvider:
Photon.Deterministic.IDeterministicReplayProvider Photon.Deterministic.IDeterministicRpcProvider Photon.Deterministic.IDeterministicInputProvider Quantum.BitStreamReplayInputProvider Quantum.StreamReplayInputProvider

Public Member Functions

int BeginReadFrame (int frame)
 Request input for a certain frame. More...
 
void CompleteReadFrame (int frame, int length, ref byte[] data)
 Read the input data for the frame. More...
 
void Reset ()
 Resets the input provider when restarting a replay for example. The stream should be reset to the beginning. More...
 
- Public Member Functions inherited from Photon.Deterministic.IDeterministicRpcProvider
void AddRpc (int playerSlot, byte[] data, bool command)
 Adds an RPC to the simulation. More...
 
QTuple< byte[], bool > GetRpc (int frame, int player)
 Gets the RPC data for the given frame and player. More...
 
- Public Member Functions inherited from Photon.Deterministic.IDeterministicInputProvider
bool CanSimulate (int frame)
 Is all input for this frame available. More...
 
DeterministicFrameInputTemp GetInput (int frame, int playerSlot)
 Get the input for the given frame and player. More...
 

Properties

int MaxFrame [get]
 The maximum frame number that the input provider can provide at a given moment. More...
 
- Properties inherited from Photon.Deterministic.IDeterministicReplayProvider
int LocalActorNumber [get]
 Setting the correct local actor number makes DeterministicSession.IsLocalPlayer(Quantum.PlayerRef) work in replays similar to normal Quantum sessions. More...
 

Detailed Description

The interface to implement streaming input for a Quantum replay session.

Member Function Documentation

◆ BeginReadFrame()

int Photon.Deterministic.IDeterministicStreamReplayInputProvider.BeginReadFrame ( int  frame)

Request input for a certain frame.

Parameters
frameThe frame for the requested input
Returns
The size of the input to be read

Implemented in Quantum.StreamReplayInputProvider, and Quantum.BitStreamReplayInputProvider.

◆ CompleteReadFrame()

void Photon.Deterministic.IDeterministicStreamReplayInputProvider.CompleteReadFrame ( int  frame,
int  length,
ref byte[]  data 
)

Read the input data for the frame.

Parameters
frameThe frame to read the input for
lengthThe input length requested in BeginReadFrame(int)
dataThe array to copy input data to

Implemented in Quantum.StreamReplayInputProvider, and Quantum.BitStreamReplayInputProvider.

◆ Reset()

void Photon.Deterministic.IDeterministicStreamReplayInputProvider.Reset ( )

Resets the input provider when restarting a replay for example. The stream should be reset to the beginning.

Implemented in Quantum.StreamReplayInputProvider, and Quantum.BitStreamReplayInputProvider.

Property Documentation

◆ MaxFrame

int Photon.Deterministic.IDeterministicStreamReplayInputProvider.MaxFrame
get

The maximum frame number that the input provider can provide at a given moment.