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
Namespace: Unity.NetCode
Assembly: Unity.NetCode.dll
Syntax
public struct CommandSendSystem<TCommandDataSerializer, TCommandData> where TCommandDataSerializer : unmanaged, ICommandDataSerializer<TCommandData> where TCommandData : unmanaged, ICommandData
Type Parameters
Name Description
TCommandDataSerializer

Unmanaged CommandDataSerializer of type ICommandDataSerializer.
TCommandData

Unmanaged CommandData of type ICommandData.

Properties

Query

The query to use when scheduling the processing job.

Declaration
public 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<TCommandDataSerializer, TCommandData>.SendJobData

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

OnCreate(ref SystemState)

Initialize the helper struct, should be called from OnCreate in an ISystem.

Declaration
public void OnCreate(ref SystemState state)
Parameters
Type Name Description
SystemState state

Unity.Entities.SystemState

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
bool

Whether the processing job needs to run.