Api Sandbox Clutter ClutterComponent
class

ClutterComponent

public sealed class ClutterComponent : Component

Clutter scattering component supporting both infinite and volumes.

Constructors

ClutterComponent()

Properties

Name Type Description
Clutter ClutterDefinition The clutter containing objects to scatter and scatter settings.
Seed Int32 Seed for deterministic generation. Change to get different variations.
Mode ClutterMode Clutter generation mode - Volume or Infinite streaming.
Infinite Boolean Returns true if in infinite streaming mode.
Bounds BBox
Storage ClutterStorage Storage for volume model instances. Serialized with component.

Methods

Void ClearInfinite()

Clears all infinite mode tiles for this component.

Void InvalidateTileAt(Vector3 worldPosition)

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

Void InvalidateTilesInBounds(BBox bounds)

Invalidates all tiles within the given bounds, causing them to regenerate.

Void Generate()
Void Clear()
Assembly: Sandbox.Engine Namespace: Sandbox.Clutter Full Name: Sandbox.Clutter.ClutterComponent