Config Documentation¶
Contents¶
- Config Files
- Config Objects
- Float
- Integer
- NoiseSampler
- String
- List
- Map
- Boolean
- Range
- WeightedList
- Block
- PipelineBiome
- Tag
- Pattern
- ColorSampler
- Set
- Distributor
- Locator
- Image
- Expression
- Biome
- Palette
- DimensionApplicableSampler
- MathFunction
- ColorString
- BiomeProvider
- BiomeColorMapping
- ExtrusionReplaceableBiome
- Source
- Stage
- Point
- Feature
- Structure
- GenerationStage
- PlatformBiome
- ChunkGenerator
- PipelineBiomeColorConverter
- PaletteLayer
- BiomeColorConverter
- Extrusion
- SlantLayer
- CubicSplinePoint
- NumberPredicate
- TerraScript
Documentation Format¶
Configs are documented in the following format:
<ConfigName>
<Description of ConfigName>
<required-parameter> <Type> - <Summary>
A parameter that must be defined for the config to be valid.
<optional-parameter> <Type> - <Summary>
Default: Default value
A parameter that may optionally be defined but is not essential.
<ConfigName> Example
<required-parameter>: ... # Object matching the parameter type
<optional-parameter>: ...
*Some documented configs may not contain any optional parameters and or an example config.
Config Specific Objects¶
Some parameters may require a type specific to that particular config. In these cases, the documentation of that contained type will be included in the main config’s documentation:
ExampleConfig
A config containing a parameter that requires an object specific to the config.
example-object ConfigSpecificObject
ConfigSpecificObject
An object specific to ExampleConfig.
object-parameter String
ExampleConfig Example
example-object:
object-parameter: A string.