Interface ICommandData

Commands (usually inputs) that must be sent from client to server to control an entity (or any other thing) should implement the ICommandData interface.

Prefer using the ICommandData over Rpc if you need to send a constant stream of data from client to server, as it's optimized for this use-case.

Prefer to keep this type as small as possible, as it scales exponentially with player count and tickrate.

ICommandData, being a subclass of IBufferElementData, can also be serialized from the server to the clients. It also natively supports the presence of the GhostComponentAttribute and GhostFieldAttribute attributes. As such, the same rule for buffers apply: if the command buffer must be serialized, then all fields must be annotated with a GhostFieldAttribute. Failure to do so will generate code-generation errors.

However, differently from a normal GhostComponent, ICommandData buffers are not replicated from the server to all clients by default. Instead, in the absence of a GhostComponentAttribute governing the serialization behavior, the following set of default rules are used:

- PrefabType is set to All. The buffer is present on all the ghost variant.

- SendTypeOptimization is set to OnlyPredictedClients. Only predicted ghost can receive the buffer and interpolated variant will have the component stripped or disabled.

- OwnerSendType is set to SendToNonOwner. If the ghost has an owner, is sent only to the clients who don't own the ghost.

Is generally not recommended to send back to the ghost owner its own commands. For that reason, setting the SendToOwner flag will be reported as a error and ignored. Also, because they way ICommandData works, some care must be used when setting the PrefabType property:

- Server: While possible, does not make much sense. A warning will be reported.

- Clients: The ICommandData buffer is stripped from the server ghost. A warning will be reported.

- InterpolatedClient: ICommandData buffers are stripped from the server and predicted ghost. A warning will be reported.

- Predicted: ICommandData buffers are stripped from the server and predicted ghost. A warning will be reported.

- AllPredicted: Interpolated ghost will not have the command buffer.

- All: All ghost will have the command buffer.

Namespace: Unity.NetCode

Assembly: Unity.NetCode.dll

Syntax

public interface ICommandData : IBufferElementData

Properties

Tick

The tick the command should be executed. It is mandatory to set the tick before adding the command to the buffer using AddCommandData<T>(DynamicBuffer<T>, T).

Declaration

NetworkTick Tick { get; set; }

Property Value

Type	Description
NetworkTick

Methods

ToFixedString()

Implement this to get Burst-compatible input struct packet dump logging. Recommended format: $"field1:, field2:";

Declaration

FixedString512Bytes ToFixedString()

Returns

Type	Description
FixedString512Bytes	Field values of your input struct.

Remarks

This function must be burst compatible too, otherwise you'll get burst compiler errors.