API ReferenceSandbox.Clutter

ClutterComponentclass

Clutter scattering component supporting both infinite and volumes.

object→Component→ClutterComponent

Namespace: Sandbox.Clutter
Assembly: Sandbox.Engine
Declaration: public sealed class Sandbox.Clutter.ClutterComponent : Sandbox.Component

Constructors1

Showing 1 constructors

public ClutterComponent()PUBLICCONSTRUCTOR

Methods5

Showing 5 methods

public void Clear()PUBLIC

Returns:void—

public void ClearInfinite()PUBLIC

Clears all infinite mode tiles for this component.

Returns:void—

public void Generate()PUBLIC

Returns:void—

public void InvalidateTileAt(Vector3 worldPosition)PUBLIC

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

Parameter	Type	Description
worldPosition	`Vector3`	—

Returns:void—

public void InvalidateTilesInBounds(BBox bounds)PUBLIC

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

Parameter	Type	Description
bounds	`BBox`	—

Returns:void—

Properties6

Showing 6 properties

public BBox Sandbox.Clutter.ClutterComponent.Bounds { get; set; }PUBLICGETSET

Returns:BBox—

public Sandbox.Clutter.ClutterDefinition Sandbox.Clutter.ClutterComponent.Clutter { get; set; }PUBLICGETSET

The clutter containing objects to scatter and scatter settings.

Returns:ClutterDefinition—

public bool Sandbox.Clutter.ClutterComponent.Infinite { get; set; }PUBLICGETSET

Returns true if in infinite streaming mode.

Returns:bool—

public Sandbox.Clutter.ClutterComponent.ClutterMode Sandbox.Clutter.ClutterComponent.Mode { get; set; }PUBLICGETSET

Clutter generation mode - Volume or Infinite streaming.

Returns:ClutterMode—

public int Sandbox.Clutter.ClutterComponent.Seed { get; set; }PUBLICGETSET

Seed for deterministic generation. Change to get different variations.

Returns:int—

public Sandbox.Clutter.ClutterGridSystem.ClutterStorage Sandbox.Clutter.ClutterComponent.Storage { get; set; }PUBLICGETSET

Storage for volume model instances. Serialized with component.

Returns:ClutterStorage—

→Clutter

WithWishVelocity()

Bounds

Constructors

public ClutterComponent()

Methods

public System.Void Clear()

public System.Void ClearInfinite()

public System.Void Generate()

public System.Void InvalidateTileAt(Vector3 worldPosition)

public System.Void InvalidateTilesInBounds(BBox bounds)

Properties

public BBox Sandbox.Clutter.ClutterComponent.Bounds { get; set; }

public Sandbox.Clutter.ClutterDefinition Sandbox.Clutter.ClutterComponent.Clutter { get; set; }

public System.Boolean Sandbox.Clutter.ClutterComponent.Infinite { get; set; }

public Sandbox.Clutter.ClutterComponent.ClutterMode Sandbox.Clutter.ClutterComponent.Mode { get; set; }

public System.Int32 Sandbox.Clutter.ClutterComponent.Seed { get; set; }

public Sandbox.Clutter.ClutterGridSystem.ClutterStorage Sandbox.Clutter.ClutterComponent.Storage { get; set; }

Metadata

ClutterComponentclass

Constructors1

Methods5

Properties6

Related Guides

On this page