s&box docs
API ReferenceSandbox

public abstract class Sandbox.BlobData

Base class for properties that should be serialized to binary format instead of JSON. Used for large data structures that would be inefficient as JSON.

Broader workflow and conceptual references connected to this API.

Binary Serialization

In the event that you find your JSON files growing too much due to too much data. You can store data as a binary blob. This will work with anything that serializes to JSON.

Constructors

Showing 1 constructors

Methods

Showing 3 methods

public virtual void Deserialize(Sandbox.BlobData.Reader reader)

Deserialize this object from binary format.

public virtual void Serialize(Sandbox.BlobData.Writer writer)

Serialize this object to binary format.

public virtual void Upgrade(Sandbox.BlobData.Reader reader, int fromVersion)

Optional upgrade path for old data versions. Called if the data version is older than current Version.

Properties

Showing 1 properties

public virtual int Sandbox.BlobData.Version { get; set; }

The version of this binary data format. Used for upgrade paths.

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.BlobData

BlitOverlay

Previous Page

Bloom

Next Page

On this page

Constructorsprotected BlobData()Methodspublic virtual System.Void Deserialize(Sandbox.BlobData.Reader reader)public virtual System.Void Serialize(Sandbox.BlobData.Writer writer)public virtual System.Void Upgrade(Sandbox.BlobData.Reader reader, System.Int32 fromVersion)Propertiespublic virtual System.Int32 Sandbox.BlobData.Version { get; set; }Metadata