Function syncField

Marks a field for automatic network synchronization across connected clients.
When a synced field changes, the new value is automatically broadcast to all users in the room.

Primitives (string, number, boolean) sync automatically.
For arrays/objects, reassign to trigger sync: this.myArray = this.myArray

Example: Basic sync

class MyComponent extends Behaviour {
  @syncField() playerScore: number = 0;
}

Example: With change callback

class MyComponent extends Behaviour {
  @syncField("onHealthChanged") health: number = 100;

  onHealthChanged(newValue: number, oldValue: number) {
    console.log(`Health: ${oldValue} → ${newValue}`);
  }
}

Example: Preventing sync (one-way)

class MyComponent extends Behaviour {
  @syncField(function(newVal, oldVal) {
    // Process incoming value but don't sync our changes
    return false;
  }) serverControlled: string = "";
}

See

serializable for editor serialization

Link

https://engine.needle.tools/docs/how-to-guides/networking/

  • syncField(
        onFieldChanged?: undefined | null | string | FieldChangedCallbackFn,
    ): (target: any, _propertyKey: string | { name: string }) => void

    Parameters

    • onFieldChanged: undefined | null | string | FieldChangedCallbackFn = null

      Optional callback when the field changes (locally or from network).
      Return false to prevent syncing this change to others.

    Returns (target: any, _propertyKey: string | { name: string }) => void

Settings

Member Visibility