Method getNetworkSyncData

GDJS/Runtime/variable.ts:135–184

(
      syncOptions: GetNetworkSyncDataOptions
    )

    };

    getNetworkSyncData(
      syncOptions: GetNetworkSyncDataOptions
    ): UnnamedVariableNetworkSyncData | undefined {
      if (
        // Variable undefined.
        this.isUndefinedInContainer()
      )
        return;

      const variableOwner = this.getPlayerOwnership();

      if (syncOptions.shouldExcludeVariableFromData) {
        // Saving for "save state": serialize all variables unless excluded.
        if (syncOptions.shouldExcludeVariableFromData(this)) {
          return;
        }
      } else {
        // Saving for "multiplayer": only serialize the variable if owned by the player.
        const syncedPlayerNumber = syncOptions.playerNumber;
        const isHost = syncOptions.isHost;

        if (
          // Variable marked as not to be synchronized.
          variableOwner === null ||
          // Getting sync data for a specific player:
          (syncedPlayerNumber !== undefined &&
            // Variable is owned by host but this player number is not the host.
            variableOwner === 0 &&
            !isHost) ||
          // Variable is owned by a player but not getting sync data for this player number.
          (variableOwner !== 0 && syncedPlayerNumber !== variableOwner)
        ) {
          // In those cases, the variable should not be synchronized.
          return;
        }
      }

      const variableType = this.getType();
      const variableValue =
        variableType === 'structure' || variableType === 'array'
          ? ''
          : this.getValue();

      return {
        value: variableValue,
        type: variableType,
        children: this.getStructureNetworkSyncData(this),
        owner: variableOwner,
      };
    }

    // Structure variables can contain other variables, so we need to recursively
    // get the sync data for each child variable.