s&box docs
API ReferenceSandbox.Clutter

ClutterGridSystemclass

Game object system that manages clutter generation. Handles infinite streaming layers and executes generation jobs.

object→GameObjectSystem→ClutterGridSystem
Namespace
Sandbox.Clutter
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Clutter.ClutterGridSystem : Sandbox.GameObjectSystem

Constructors1

Showing 1 constructors

Methods9

Showing 9 methods

public void ClearAllPainted()PUBLIC

Clears all painted clutter (both model instances from storage and prefab GameObjects). Does not affect clutter owned by ClutterComponent volumes.

Returns:void—

public void ClearComponent(Sandbox.Clutter.ClutterComponent component)PUBLIC

Clears all tiles for a specific component.

ParameterTypeDescription
componentClutterComponent—
Returns:void—

public virtual void Dispose()PUBLICVIRTUAL

Returns:void—

public void Erase(Vector3 pos, float radius)PUBLIC

Erase instances. Rebuilds on next frame update. Erases both model batches and prefab GameObjects.

ParameterTypeDescription
posVector3—
radiusfloat—
Returns:void—

public void Flush()PUBLIC

Flush painted changes and rebuild visual batches immediately.

Returns:void—

public void InvalidateTileAt(Sandbox.Clutter.ClutterComponent component, Vector3 worldPosition)PUBLIC

Invalidates the tile at the given world position for a component, causing it to regenerate.

ParameterTypeDescription
componentClutterComponent—
worldPositionVector3—
Returns:void—

public void Paint(Sandbox.Clutter.ClutterEntry entry, Vector3 pos, Rotation rot, float scale = 1)PUBLIC

Paint instance. Rebuilds on next frame update. Models are batched, Prefabs become GameObjects.

ParameterTypeDescription
entryClutterEntry—
posVector3—
rotRotation—
scale = 1float—
Returns:void—

Properties1

Showing 1 properties

ClutterEntry.ctor()

Previous Page

Storage

Next Page

On this page

Constructorspublic ClutterGridSystem(Sandbox.Scene scene)Methodspublic System.Void ClearAllPainted()public System.Void ClearComponent(Sandbox.Clutter.ClutterComponent component)public virtual System.Void Dispose()public System.Void Erase(Vector3 pos, System.Single radius)public System.Void Flush()public System.Void InvalidateTileAt(Sandbox.Clutter.ClutterComponent component, Vector3 worldPosition)public System.Void InvalidateTilesInBounds(BBox bounds)public System.Void InvalidateTilesInBounds(Sandbox.Clutter.ClutterComponent component, BBox bounds)public System.Void Paint(Sandbox.Clutter.ClutterEntry entry, Vector3 pos, Rotation rot, System.Single scale = 1)Propertiespublic Sandbox.Clutter.ClutterGridSystem.ClutterStorage Sandbox.Clutter.ClutterGridSystem.Storage { get; set; }Metadata