Persistent Asset - Public API

CoreThe foundation: persistent assets, managers and the save API.

Core types

SOPersistentScriptableObject PMPersistenceManager staticPersistence staticSaveData2.0 staticGlobalPersistedData

Operations & results

abstractResult sealedLoadResult sealedSaveResult sealedClearResult enumResultType enumExecutionMode enumPersistenceSource sealedPersistenceOperation<TResult>

Readiness

structReadiness2.0 enumNotReadyReason2.0 enumDataOrigin2.0

Optional interfaces

ifaceIUpgradable ifaceIMergeable2.0 ifaceIFieldResettable ifaceIScopeCallbacks ifaceISerializationCallbacks ifaceIDirtyTracked ifaceIDynamicInitialize ifaceIPersistencePolicy structPersistencePolicy

Save slots

staticSlots abstractPersistentSlotRegistry<TTarget, TInfo> structSlotEntry<TInfo> ifaceISlotListing2.0 structSaveScreenshot enumScreenshotFormat

Conflicts

staticConflicts2.0 sealedConflictInfo2.0 enumConflictResolution2.0

Player UI

MBPersistenceConflictPrompt2.0 MBPersistenceDrainDisplay2.0

Serialization

abstractSerializer abstractSaveNode

Asset references

staticAssetRegistry

Debugging

enumLogLevel MBPersistenceDebugOverlay2.0 enumDebugOverlayCorner2.0 staticPersistentAssetConsole

Attributes

attrAttributes

Built-InsReady-made managers, storage backends, security and helpers.

Open the Built-Ins reference →

Local managers

PMPrototype PMLocal File PMPlayer Prefs

Remote managers

PMRemotePersistenceManager PMServer (HTTP) PMCloud Save (UGS) enumRemote enums staticRemoteSettings PMSteam Cloud2.0 enumstructHttpVerb / HttpNotFound / HttpEmptyAnswer / HttpHeader2.0

Other managers

PMPlatform (Routing)2.0 PMSession PMTest

Serializers

classUnityJsonSerializer classNewtonsoftJsonSerializer classOdinDataSerializer classMemoryPackDataSerializer2.0 abstractMemoryPackScriptableObject2.0 sealedAssetFormatter<T>2.0

Security

enumEncryption enumCompression enumSaveAnchor

Utilities

staticSaveFileUtility staticCheatProtectionUtility staticGzipUtility staticTaskUtility staticSlotFormatUtility staticWebGLFileSync staticSaveNodeJson staticFieldSnapshot enumThreadType enumSaveLocation

No-CodePersist data straight from the inspector, no scripting.

Open the No-Code reference →

Variables & components

SOPersistentVariables structVariableRef structVariableValueRef<T> structVariableListRef<T> structVariableMapRef<TKey, TValue> abstractVariableComponent MBVariableBinder MBVariableListener MBVariableSetter enumVariableSetter.Operation enumBindingDirection classVariableList<T> classVariableMap<TKey, TValue>

Extending

abstractVariableTypeCodec abstractVariableTypeCodec<T> staticVariableTypes abstractValueConverter abstractValueConverter<TFrom, TTo> staticValueConverters

Input & localization

staticInputBindingPersistence staticLocalePersistence

Persistence components

MBPersistenceComponent2.0 MBPersistenceOperationControl2.0 MBPersistenceOperationListener2.0 MBPersistenceConflictListener2.0 MBPersistenceDrainListener2.0

Save menu

SOSlot registry2.0 structVariablesSlotInfo2.0 MBSlotList2.0 MBSlotListRow2.0

Attributes

attrVariableType

Scene Objects 2.0Save what is in your scene: state, what exists, and references to it.

Open the Scene Objects reference →

The pieces

SOPersistentSceneState MBsealedPersistentSceneObject structSceneRef

Codecs

abstractSceneComponentCodec staticSceneComponentCodecs

Prefs 2.0Named values saved from anywhere, with nothing to set up.

Open the Prefs reference →

The pieces

staticPrefs SOPersistentPrefs

Editor ExtensionCustomize the package's inspectors, drawers and tooling.

Open the Editor Extension reference →

Editors, drawers & GUI

EditorPersistenceManagerEditor EditorRemotePersistenceManagerEditor EditorSlotRegistryEditor EditorPersistentVariablesEditor EditorPersistentSceneStateEditor2.0 drawerSerializerDrawer staticPersistenceManagerEditorGUI staticManagerComposition2.0 staticPersistentAssetEditorGUI staticSecurityGUI staticSlotFormatGUI staticSerializedObjectExtensions abstractVariableWidget<T> structTypeDisplay staticAssetRegistration

Object & manager operations

staticPersistentObjects2.0 staticManagerSetup2.0 staticGeneratedAssets2.0

Project settings

abstractSettingsEntry staticSettings drawerSettingsEntryDrawer sealedSettingsTestScope2.0

Attributes

attrClearLocalData