Class ClutterConfig

Configuration class for adding custom clutter.
Use this in a constructor of CustomClutter
Inheritance
object
ClutterConfig
Inherited Members
Namespace: Jotunn.Configs
Assembly: Jotunn.dll
Syntax
public class ClutterConfig

Constructors

Name Description
ClutterConfig() Create a new ClutterConfig
ClutterConfig(Clutter) Create a copy of the ClutterSystem.Clutter

Properties

Name Description
Amount The amount of displayed clutter prefabs per patch. For high values an InstanceRenderer should be used to lower the amount of overall prefabs.
Biome Biome to spawn in, multiple Biomes can be allowed with AnyBiomeOf(params Biome[]).
Default to all biomes.
Enabled Whether this clutter gets spawned in the world. Defaults to true.
ForestThresholdMax Maximum value of the forest fractal:
0 - 1: inside the forest
1: forest edge
1 - infinity: outside the forest
ForestThresholdMin Minimum value of the forest fractal:
0 - 1: inside the forest
1: forest edge
1 - infinity: outside the forest
FractalOffset Offset of the noise map.
FractalScale Size of a noise map used to determine if the clutter should be placed. Set to 0 to disable and place it everywhere.
FractalThresholdMax Maximum value of the noise map to place the clutter.
FractalThresholdMin Minimum value of the noise map that is needed to place the clutter.
InForest Whether the clutter should check for forest thresholds.
Instanced Whether this clutter has an InstanceRenderer attached that should be used.
MaxAltitude Maximum terrain height this clutter will be placed on.
MaxOceanDepth Maximum ocean depth to place this clutter. Needs OceanDepthCheck to be true.
MaxTilt Maximum terrain tilt in degrees this clutter will be placed on.
MinAltitude Minimum terrain height this clutter will be placed on.
MinOceanDepth Minimum ocean depth that is needed to place this clutter. Needs OceanDepthCheck to be true.
OceanDepthCheck Whether the clutter should check for ocean height.
OnCleared Whether this clutter should be shown on modified ground.
OnUncleared Whether this clutter should be shown on unmodified ground.
RandomOffset Random y offset of every individual prefab. Calculated after SnapToWater.
ScaleMax Maximum random size of the prefab, only active when Instanced is used.
ScaleMin Minimum random size of the prefab, only active when Instanced is used.
SnapToWater Whether the y position will always be at water level. Used before RandomOffset
TerrainTilt Whether this clutter will be rotated with the underlying terrain. Otherwise it will always point straight up.

Extension Methods