RecoveryMode

Controls how RestoreFromJson(string, RecoveryMode, ResolutionPolicy) behaves when a replay commit cannot be applied — for example because the project has been edited since the save was written and a referenced node no longer exists.

public enum RecoveryMode

Fields

BestEffort 0

Skip unresolvable commits and continue applying the remaining path. The restore lands as close to the original save point as possible even when the project has changed. Unresolved steps are recorded in Warnings with code "replay.step_unresolved". This is the default.

Transactional 1

Abort the entire restore on the first unresolvable commit. The runtime is left in its initial state and FailureReason carries the failure description. Use this when a partial restore is worse than no restore at all — for example in automated testing or CI.

Remarks

Pass your chosen mode as the recoveryMode argument to RestoreFromJson(string, RecoveryMode, ResolutionPolicy). The default is BestEffort, which maximises how far the restore progresses; use Transactional when you need an all-or-nothing guarantee.

Docs last synced: 2026-07-08
Screenshot viewer