s&box docs
API ReferenceSandbox

BlobDataclass

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.

object→BlobData
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.BlobData

Constructors1

Showing 1 constructors

protected BlobData()PROTECTEDCONSTRUCTOR

Methods3

Showing 3 methods

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

Deserialize this object from binary format.

ParameterTypeDescription
readerReader—
Returns:void—

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

Serialize this object to binary format.

ParameterTypeDescription
writerWriter—
Returns:void—

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

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

ParameterTypeDescription
readerReader—
fromVersionint—
Returns:void—

Properties1

Showing 1 properties

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

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

Returns:int—

Related Guides

→Binary Serialization

Render()

Previous Page

Version

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