s&box docs
API Referenceglobal

ClutterStorageclass

Manages storage and serialization of painted clutter instances. Uses binary serialization via BlobData for efficient storage.

object→BlobData→ClutterStorage
Namespace
global
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Clutter.ClutterGridSystem.ClutterStorage : Sandbox.BlobData

Constructors1

Showing 1 constructors

Methods9

Showing 9 methods

public void AddInstance(string modelPath, Vector3 position, Rotation rotation, float scale = 1)PUBLIC

Adds a single instance for a model.

ParameterTypeDescription
modelPathstring—
positionVector3—
rotationRotation—
scale = 1float—
Returns:void—

public void AddInstances(string modelPath, System.Collections.Generic.IEnumerable`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance> instances)PUBLIC

ParameterTypeDescription
modelPathstring—
instancesIEnumerable<Instance>—
Returns:void—

public void ClearAll()PUBLIC

Clears all instances.

Returns:void—

public bool ClearModel(string modelPath)PUBLIC

Clears all instances for a specific model.

ParameterTypeDescription
modelPathstring—
Returns:bool—

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

Deserialize from binary format.

ParameterTypeDescription
readerReader—
Returns:void—

public int Erase(Vector3 position, float radius)PUBLIC

Erases all instances within a radius of a position.

ParameterTypeDescription
positionVector3—
radiusfloat—
Returns:int—

public System.Collections.Generic.IReadOnlyDictionary`2<string,System.Collections.Generic.List`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance>> GetAllInstances()PUBLIC

Gets all instances grouped by model path.

Returns:IReadOnlyDictionary<string,List<Instance>>—

public System.Collections.Generic.IReadOnlyList`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance> GetInstances(string modelPath)PUBLIC

Gets instances for a specific model path.

ParameterTypeDescription
modelPathstring—
Returns:IReadOnlyList<Instance>—

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

Serialize to binary format.

ParameterTypeDescription
writerWriter—
Returns:void—

Properties3

Showing 3 properties

public System.Collections.Generic.IEnumerable`1<string> Sandbox.Clutter.ClutterGridSystem.ClutterStorage.ModelPaths { get; set; }PUBLICGETSET

Gets all model paths that have instances.

Returns:IEnumerable<string>—

public int Sandbox.Clutter.ClutterGridSystem.ClutterStorage.TotalCount { get; set; }PUBLICGETSET

Gets the total number of instances across all models.

Returns:int—

TileSizeOption

Previous Page

ModelPaths

Next Page

On this page

Constructorspublic ClutterStorage()Methodspublic System.Void AddInstance(System.String modelPath, Vector3 position, Rotation rotation, System.Single scale = 1)public System.Void AddInstances(System.String modelPath, System.Collections.Generic.IEnumerable`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance> instances)public System.Void ClearAll()public System.Boolean ClearModel(System.String modelPath)public virtual System.Void Deserialize(Sandbox.BlobData.Reader reader)public System.Int32 Erase(Vector3 position, System.Single radius)public System.Collections.Generic.IReadOnlyDictionary`2<System.String,System.Collections.Generic.List`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance>> GetAllInstances()public System.Collections.Generic.IReadOnlyList`1<Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Instance> GetInstances(System.String modelPath)public virtual System.Void Serialize(Sandbox.BlobData.Writer writer)Propertiespublic System.Collections.Generic.IEnumerable`1<System.String> Sandbox.Clutter.ClutterGridSystem.ClutterStorage.ModelPaths { get; set; }public System.Int32 Sandbox.Clutter.ClutterGridSystem.ClutterStorage.TotalCount { get; set; }public virtual System.Int32 Sandbox.Clutter.ClutterGridSystem.ClutterStorage.Version { get; set; }Metadata