Skip to content
API referenceDevelopmentEngine APIEngine ccf7d03f
Synced

ScenePropertySerialization.RestoreProperties

Section titled “ScenePropertySerialization.RestoreProperties”
  • Restores independently captured properties into a live scene object.

API: engine
Project: Inno.Scene

public static Inno.Core.Serialization.SerializationPropertyRestoreResult Inno.Scene.ScenePropertySerialization.RestoreProperties(Inno.Scene.EngineObject target, System.ReadOnlySpan<byte> data, Inno.Core.Serialization.SerializationRegistry serialization, Inno.Assets.IAssetReferenceResolver assets, Inno.Core.Serialization.SerializationPropertyRestoreMode mode = Inno.Core.Serialization.SerializationPropertyRestoreMode.Strict)

Parameter target: The current object generation receiving the values.

Parameter data: Bytes produced by M:Inno.Scene.ScenePropertySerialization.CaptureProperty(Inno.Scene.EngineObject,System.String,Inno.Core.Serialization.SerializationRegistry,Inno.Assets.IAssetReferenceResolver) or M:Inno.Scene.ScenePropertySerialization.CaptureProperties(Inno.Scene.EngineObject,Inno.Core.Serialization.SerializationRegistry,Inno.Assets.IAssetReferenceResolver).

Parameter mode: The policy applied to unavailable or mismatched current properties.

Parameter serialization: The serialization registry that owns the active converter generation.

Parameter assets: The resolver used to materialize canonical asset references in restored values.

A summary of restored, ignored, and incompatible properties.

Exception T:System.ArgumentNullException: Thrown when target is null.

Exception T:System.InvalidOperationException: Thrown when strict restoration fails or the target is not in a loaded scene.