Struct CommandSendSystem<TCommandDataSerializer, TCommandData>

Helper struct for implementing systems to send commands. This is generally used by code-gen and should only be used directly in special cases.

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.NetCode

Syntax

public struct CommandSendSystem<TCommandDataSerializer, TCommandData>
    where TCommandDataSerializer : struct, ICommandDataSerializer<TCommandData> where TCommandData : struct, ICommandData

Type Parameters

Name	Description
TCommandDataSerializer	Unmanaged CommandDataSerializer of type ICommandDataSerializer.
TCommandData	Unmanaged CommandData of type ICommandData.

Fields

k_InputBufferSendSize

The maximum number of inputs sent in each command packet. Resending the last 3 commands adds some redundancy, minimizing the effect of packet loss (unless that packet loss is sustained).

Declaration

public const uint k_InputBufferSendSize = 4U

Field Value

Type	Description
UInt32

k_MaxCommandSerializedPayloadBytes

The maximum serialized size of an individual Command payload, including command headers, and including the above k_InputBufferSendSize delta-compressed redundancy.

Declaration

public const int k_MaxCommandSerializedPayloadBytes = 1024

Field Value

Type	Description
Int32

Properties

Query

The query to use when scheduling the processing job.

Declaration

public readonly EntityQuery Query { get; }

Property Value

Type	Description
EntityQuery

Methods

InitJobData(ref SystemState)

Initialize the internal state of a processing job, should be called from OnUpdate of an ISystem.

Declaration

public CommandSendSystem<TCommandDataSerializer, TCommandData>.SendJobData InitJobData(ref SystemState state)

Parameters

Type	Name	Description
SystemState	state	Raw entity system state.

Returns

Type	Description
CommandSendSystem.SendJobData<>	Constructed CommandSendSystem<TCommandDataSerializer, TCommandData>.SendJobData with initialized state.

ShouldRunCommandJob(ref SystemState)

Utility method to check if the processing job needs to run, used as an early-out in OnUpdate of an ISystem.

Declaration

public bool ShouldRunCommandJob(ref SystemState state)

Parameters

Type	Name	Description
SystemState	state	Raw entity system state.

Returns

Type	Description
Boolean	Whether the processing job needs to run.