API ReferenceSandbox.Clutter
TerrainMaterialScattererclass
Scatterer that selects assets based on the terrain material at the hit position. Useful for placing different vegetation on different terrain textures (grass, dirt, rock, etc).
Constructors1
Showing 1 constructors
public TerrainMaterialScatterer()
No results match this filter.
Methods1
Showing 1 methods
protected virtual System.Collections.Generic.List`1<Sandbox.Clutter.ClutterInstance> Generate(BBox bounds, Sandbox.Clutter.ClutterDefinition clutter, Sandbox.Scene scene = null)
| Parameter | Type | Description |
|---|---|---|
| bounds | BBox | — |
| clutter | ClutterDefinition | — |
| scene = null | Scene | — |
No results match this filter.
Properties7
Showing 7 properties
public bool Sandbox.Clutter.TerrainMaterialScatterer.AlignToNormal { get; set; }
Align objects to surface normal.
Returns:
bool—public float Sandbox.Clutter.TerrainMaterialScatterer.Density { get; set; }
Points per square meter (density).
Returns:
float—public float Sandbox.Clutter.TerrainMaterialScatterer.HeightOffset { get; set; }
Offset from ground surface.
Returns:
float—public System.Collections.Generic.List`1<Sandbox.Clutter.TerrainMaterialMapping> Sandbox.Clutter.TerrainMaterialScatterer.Mappings { get; set; }
Define which entries spawn on which terrain materials.
public bool Sandbox.Clutter.TerrainMaterialScatterer.RandomYaw { get; set; }
Apply random rotation around vertical axis.
Returns:
bool—public RangedFloat Sandbox.Clutter.TerrainMaterialScatterer.Scale { get; set; }
Scale range for spawned objects.
public bool Sandbox.Clutter.TerrainMaterialScatterer.UseFallback { get; set; }
Use random clutter entry if no material mapping matches or no terrain is present.
Returns:
bool—No results match this filter.