Photon Quantum 3.0.0

Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Photon.Deterministic.DeterministicTickInput Class Reference

The internal input structure for one player and one tick. More...

Classes

class  CorruptedException
 The corrupted exception is thrown when error during the deserialization are detected. More...
 
class  Pool
 The input objects are pooled. More...
 

Public Member Functions

DeterministicTickInput Clone ()
 Clone the object. More...
 
void CopyToDataArray (byte[] array, int length)
 Copy the array into the DataArray. More...
 
void Legacy_Serialize_Packed (Protocol.Serializer serializer, BitStream stream, DeterministicTickInputEncodeHeader header)
 Legacy serialization. More...
 
void Legacy_Serialize_Simple (Protocol.Serializer serializer, BitStream stream)
 Legacy serialization. More...
 
void SerializeForDecoder (Protocol.Serializer serializer, BitStream stream, DeterministicTickInputEncodeHeader header)
 Internal method to serialize the input data. More...
 
void SerializeForDecoderRPC (Protocol.Serializer serializer, BitStream stream, DeterministicTickInputEncodeHeader header)
 Read and write rpc data from the input stream. More...
 
void SimpleSerialize (Protocol.Serializer serializer, BitStream stream, int size, Boolean ignoreRpc=false, Boolean includeHeader=true)
 Internal method to serialize the input data. More...
 
override String ToString ()
 Override ToString method to debug output readable class members. More...
 

Static Public Member Functions

static void DeserializeMultiple (Protocol.Serializer serializer, BitStream stream, List< DeterministicTickInput > result, Stack< DeterministicTickInput > pool, int expectedDataLength, Boolean ignoreRpc=false, bool delta=false)
 Internal method to deserialized multiple inputs from a bitstream. More...
 
static unsafe void Legacy_DecodeMultiple_Packed (Protocol.Serializer serializer, BitStream stream, List< DeterministicTickInput > result)
 Legacy serialization. More...
 
static void Legacy_DecodeMultiple_Simple (Protocol.Serializer serializer, BitStream stream, List< DeterministicTickInput > result)
 Legacy serialization. More...
 
static void SimpleDeserializeMultiple (Protocol.Serializer serializer, BitStream stream, List< DeterministicTickInput > result, Stack< DeterministicTickInput > pool, int expectedDataLength, Boolean ignoreRpc=false)
 Internal method to deserialized multiple inputs from a bitstream. More...
 

Public Attributes

Byte[] DataArray
 Input data. More...
 
int DataLength
 Input data length. More...
 
DeterministicInputFlags Flags
 The input flags assigned by the server. More...
 
Int32 PlayerIndex
 This represents the player index when sent from the server. Is the player slot on input upstream. More...
 
Int32 ReferenceTick
 Not serialized (for delta decompression only) More...
 
Byte[] Rpc
 Rpc data. More...
 
Boolean Sent
 Has this input been sent to the client. More...
 
Int32 Tick
 The tick of this input. More...
 

Detailed Description

The internal input structure for one player and one tick.

Represents input at a specific tick.

Member Function Documentation

◆ CopyToDataArray()

void Photon.Deterministic.DeterministicTickInput.CopyToDataArray ( byte[]  array,
int  length 
)
inline

Copy the array into the DataArray.

Parameters
arraySource input data array
lengthSource input data array size

◆ SerializeForDecoder()

void Photon.Deterministic.DeterministicTickInput.SerializeForDecoder ( Protocol.Serializer  serializer,
BitStream  stream,
DeterministicTickInputEncodeHeader  header 
)
inline

Internal method to serialize the input data.

Parameters
serializerQuantum protocol serializer
streamBitstream
headerHeader to write

◆ SerializeForDecoderRPC()

void Photon.Deterministic.DeterministicTickInput.SerializeForDecoderRPC ( Protocol.Serializer  serializer,
BitStream  stream,
DeterministicTickInputEncodeHeader  header 
)
inline

Read and write rpc data from the input stream.

Parameters
serializerQuantum protocol serializer
streamBitstream
headerHeader

◆ SimpleSerialize()

void Photon.Deterministic.DeterministicTickInput.SimpleSerialize ( Protocol.Serializer  serializer,
BitStream  stream,
int  size,
Boolean  ignoreRpc = false,
Boolean  includeHeader = true 
)
inline

Internal method to serialize the input data.

Parameters
serializerQuantum protocol serializer
streamBitstream
sizeInput size
ignoreRpcIgnore rpc
includeHeaderInclude a header
Exceptions
CorruptedException

◆ SimpleDeserializeMultiple()

static void Photon.Deterministic.DeterministicTickInput.SimpleDeserializeMultiple ( Protocol.Serializer  serializer,
BitStream  stream,
List< DeterministicTickInput result,
Stack< DeterministicTickInput pool,
int  expectedDataLength,
Boolean  ignoreRpc = false 
)
inlinestatic

Internal method to deserialized multiple inputs from a bitstream.

Parameters
serializerQuantum protocol serializer
streamBitstream
resultResulting list of inputs
poolInput object pool to use
expectedDataLengthExpected input data length to validate, 0 to disable
ignoreRpcIgnore the rpc data
Exceptions
CorruptedExceptionIs raised when the input length mismatches

◆ DeserializeMultiple()

static void Photon.Deterministic.DeterministicTickInput.DeserializeMultiple ( Protocol.Serializer  serializer,
BitStream  stream,
List< DeterministicTickInput result,
Stack< DeterministicTickInput pool,
int  expectedDataLength,
Boolean  ignoreRpc = false,
bool  delta = false 
)
inlinestatic

Internal method to deserialized multiple inputs from a bitstream.

Parameters
serializerQuantum protocol serializer
streamBitstream
resultResulting list of inputs
poolInput object pool to use
expectedDataLengthExpected input data length to validate, 0 to disable
ignoreRpcIgnore the rpc data
deltaIs input delta compressed
Exceptions
CorruptedExceptionIs raised when the input length mismatches

◆ Clone()

DeterministicTickInput Photon.Deterministic.DeterministicTickInput.Clone ( )
inline

Clone the object.

Returns
A new cloned instance.

◆ ToString()

override String Photon.Deterministic.DeterministicTickInput.ToString ( )
inline

Override ToString method to debug output readable class members.

Returns
Debug string

◆ Legacy_Serialize_Packed()

void Photon.Deterministic.DeterministicTickInput.Legacy_Serialize_Packed ( Protocol.Serializer  serializer,
BitStream  stream,
DeterministicTickInputEncodeHeader  header 
)
inline

Legacy serialization.

◆ Legacy_Serialize_Simple()

void Photon.Deterministic.DeterministicTickInput.Legacy_Serialize_Simple ( Protocol.Serializer  serializer,
BitStream  stream 
)
inline

Legacy serialization.

◆ Legacy_DecodeMultiple_Simple()

static void Photon.Deterministic.DeterministicTickInput.Legacy_DecodeMultiple_Simple ( Protocol.Serializer  serializer,
BitStream  stream,
List< DeterministicTickInput result 
)
inlinestatic

Legacy serialization.

◆ Legacy_DecodeMultiple_Packed()

static unsafe void Photon.Deterministic.DeterministicTickInput.Legacy_DecodeMultiple_Packed ( Protocol.Serializer  serializer,
BitStream  stream,
List< DeterministicTickInput result 
)
inlinestatic

Legacy serialization.

Member Data Documentation

◆ Sent

Boolean Photon.Deterministic.DeterministicTickInput.Sent

Has this input been sent to the client.

◆ Tick

Int32 Photon.Deterministic.DeterministicTickInput.Tick

The tick of this input.

◆ PlayerIndex

Int32 Photon.Deterministic.DeterministicTickInput.PlayerIndex

This represents the player index when sent from the server. Is the player slot on input upstream.

◆ Rpc

Byte [] Photon.Deterministic.DeterministicTickInput.Rpc

Rpc data.

◆ DataArray

Byte [] Photon.Deterministic.DeterministicTickInput.DataArray

Input data.

◆ DataLength

int Photon.Deterministic.DeterministicTickInput.DataLength

Input data length.

◆ ReferenceTick

Int32 Photon.Deterministic.DeterministicTickInput.ReferenceTick

Not serialized (for delta decompression only)

◆ Flags

DeterministicInputFlags Photon.Deterministic.DeterministicTickInput.Flags

The input flags assigned by the server.