logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class RestorePayloadPlanner

    Selects the shipped assets at hostage risk during an additive package upgrade and names their restore payloads. A shipped file is at hostage risk when its GUID appears in the PREVIOUS release's snapshot at a different path — a moved or renamed file: in an upgrading project the old copy still holds that GUID during import, so Unity silently skips the incoming file. Plain payload copies (.bytes) always import — no GUID can block them — which lets the cleaner restore the blocked files afterwards without a package re-import. Pure: no Unity API calls, so it is unit-testable without a running editor.

    Inheritance
    object
    RestorePayloadPlanner
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.Editor.PackageBootstrapper
    Assembly: Serenity.PackageBootstrapper.Editor.dll
    Syntax
    public static class RestorePayloadPlanner

    Methods

    BuildPayloadName(int, string)

    Builds a flat, collision-free payload file name: a running index plus the target's file name, with the .bytes extension that guarantees Unity imports it as an opaque asset.

    Declaration
    public static string BuildPayloadName(int index, string targetPath)
    Parameters
    Type Name Description
    int index
    string targetPath
    Returns
    Type Description
    string

    SelectHostageRiskAssets(IReadOnlyList<ShippedAssetEntry>, IReadOnlyList<ShippedAssetEntry>, string)

    Declaration
    public static List<ShippedAssetEntry> SelectHostageRiskAssets(IReadOnlyList<ShippedAssetEntry> currentShippedEntries, IReadOnlyList<ShippedAssetEntry> previousSnapshotEntries, string payloadFolderPath)
    Parameters
    Type Name Description
    IReadOnlyList<ShippedAssetEntry> currentShippedEntries
    IReadOnlyList<ShippedAssetEntry> previousSnapshotEntries
    string payloadFolderPath
    Returns
    Type Description
    List<ShippedAssetEntry>
    In this article
    © 2026 Serenity. All Rights Reserved