WorldGen
Biomes
Asset path: Server/WorldGen/Biomes/*.json
This object has different properties depending on the value of the Type property.
All possible options are listed below:
CustomBiomeAsset with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Custom | This field controls the type, it must be set to the constant value "Custom" to function as this type. |
| Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another CustomBiomeAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together. |
| SeedName | (Nullable) String defaults to: | The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity. |
| Zones | (Nullable) Array of the type:
BiomeZoneMembership
BiomeZoneMembership with the following properties:
| Key | Type | Description |
|---|
| Zone | (Nullable) String that matches the pattern: [^\s] and is at least 1 characters long defaults to: Reference to a ZoneAsset asset | The required nonempty exact ZoneAsset key for this membership. | | Order | Integer | The nonnegative converter position in the shared Tile and Custom order domain. It is honored only when ConvertedPin is true. | | ConvertedPin | Boolean defaults to: false | Whether the adjacent Order enters the converted partition. The converter writes this marker. The default is false. |
| The inherited zone memberships for this biome. Tile and Custom memberships share one converter order domain. |
| Interpolation | (Nullable)
InterpolationValue
InterpolationValue with the following properties:
| Key | Type | Description |
|---|
| DefaultRadius | (Nullable) Integer | The default border interpolation radius in blocks. The default is the height-threshold maximum radius. | | Biomes | (Nullable) Array of the type: InterpolationEntryValue | The ordered biome-mask entries that override DefaultRadius. |
| The optional border interpolation between this biome and selected neighboring biomes. |
| TerrainHeightThreshold | (Nullable) Either
BasicHeightThresholdValue
BasicHeightThresholdValue with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Basic | This field controls the type, it must be set to the constant value "Basic" to function as this type. | | Positions | (Nullable) Array of Integer | The ordered world Y coordinates for height interpolation. The array must match Values in length. | | Values | (Nullable) Array of Number | The condition values at corresponding Positions entries. The array must match Positions in length. |
NoiseHeightThresholdValue
NoiseHeightThresholdValue with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Noise | This field controls the type, it must be set to the constant value "Noise" to function as this type. | | Noise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The noise that selects a nested height threshold. | | Keys | (Nullable) Array of Number | The ordered noise values mapped to Thresholds entries. The array must match Thresholds in length. | | Thresholds | (Nullable) Array of the type: IndexedHeightThresholdValue | The height thresholds corresponding by index to Keys entries. |
| The world-height profile that shapes this biome's terrain surface. |
| Layers | (Nullable)
LayerValue
LayerValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) String defaults to: | The block key used where no static or dynamic layer entry applies. | | Environment | (Nullable) String | The optional environment key assigned by the default layer. |
| The default block layer of this biome. WorldGenLayerAsset memberships supply the static and dynamic layers. |
| Tint | (Nullable)
TintValue
TintValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) TintDefaultValue | The tint selection used when no conditional entry matches. | | Entries | (Nullable) Array of the type: TintEntryValue | The ordered conditional tint selections. |
| The optional weighted color tints for this biome. |
| Environment | (Nullable)
EnvironmentValue
EnvironmentValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) EnvironmentDefaultValue | The environment selection used when no conditional entry matches. | | Entries | (Nullable) Array of the type: EnvironmentEntryValue | The ordered conditional environment selections. |
| The optional weighted environment assignments for this biome. |
| Water | (Nullable) Array of the type:
WaterValue
WaterValue with the following properties:
| Key | Type | Description |
|---|
| SeedIndex | (Nullable) Integer | The preserved index used to replay the legacy water seed. Keep converted values unique and nonnegative. | | DirectEntry | Boolean defaults to: false | Whether this entry preserves the direct legacy seed path. The default is false. | | Block | (Nullable) String | The block generated by this water layer. | | Fluid | (Nullable) String | The fluid generated by this water layer. | | Min | (Nullable) Type 0 | The minimum absolute world Y range for this water layer. The default is zero. | | MinNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise that modifies the minimum world Y value. | | Max | (Nullable) Type 0 | The maximum absolute world Y range for this water layer. | | MaxNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise that modifies the maximum world Y value. | | NoiseMask | (Nullable) NoiseConditionValue | The optional noise condition for this water layer. |
| The ordered water or fluid layers generated in this biome. |
| Fade | (Nullable)
FadeValue
FadeValue with the following properties:
| Key | Type | Description |
|---|
| FadeStart | Number defaults to: 0.0 | The border distance where biome-mask fading begins, in blocks. The default is zero. | | FadeLength | Number defaults to: 0.0 | The border distance over which biome-mask fading occurs, in blocks. The default is zero. | | TerrainStart | Number defaults to: 0.0 | The border distance where terrain blending begins, in blocks. The default is zero. | | TerrainLength | Number defaults to: 0.0 | The border distance over which terrain blending occurs, in blocks. The default is zero. | | FadeHeightmap | Number | The heightmap level used for vertical fading. If absent, heightmap fading is disabled. |
| The optional border and terrain fading configuration. |
| HeightmapNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise added to the biome terrain heightmap. |
| MapColor | (Nullable) String | The hexadecimal color used to display this biome on maps. The default is red. |
| CustomBiomeGenerator | (Nullable)
CustomGeneratorValue
CustomGeneratorValue with the following properties:
| Key | Type | Description |
|---|
| Noise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The noise used to select this custom biome. | | Threshold | (Nullable) Type 1 | The accepted noise value or ranges for this custom biome. | | BiomeMask | (Nullable) Array of String | The optional tile-biome rules where this custom biome can appear. | | Priority | (Nullable) Integer | The precedence of this custom biome. Higher values are evaluated first. The default is zero. |
| The noise and priority rules that place this custom biome. |
| Tags | (Nullable) Map of the following:
Map
| Key | Type |
|---|
any String | Array of String |
| Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.
For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.
Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone. |
TileBiomeAsset with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Tile | This field controls the type, it must be set to the constant value "Tile" to function as this type. |
| Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another TileBiomeAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together. |
| SeedName | (Nullable) String defaults to: | The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity. |
| Zones | (Nullable) Array of the type:
BiomeZoneMembership
BiomeZoneMembership with the following properties:
| Key | Type | Description |
|---|
| Zone | (Nullable) String that matches the pattern: [^\s] and is at least 1 characters long defaults to: Reference to a ZoneAsset asset | The required nonempty exact ZoneAsset key for this membership. | | Order | Integer | The nonnegative converter position in the shared Tile and Custom order domain. It is honored only when ConvertedPin is true. | | ConvertedPin | Boolean defaults to: false | Whether the adjacent Order enters the converted partition. The converter writes this marker. The default is false. |
| The inherited zone memberships for this biome. Tile and Custom memberships share one converter order domain. |
| Interpolation | (Nullable)
InterpolationValue
InterpolationValue with the following properties:
| Key | Type | Description |
|---|
| DefaultRadius | (Nullable) Integer | The default border interpolation radius in blocks. The default is the height-threshold maximum radius. | | Biomes | (Nullable) Array of the type: InterpolationEntryValue | The ordered biome-mask entries that override DefaultRadius. |
| The optional border interpolation between this biome and selected neighboring biomes. |
| TerrainHeightThreshold | (Nullable) Either
BasicHeightThresholdValue
BasicHeightThresholdValue with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Basic | This field controls the type, it must be set to the constant value "Basic" to function as this type. | | Positions | (Nullable) Array of Integer | The ordered world Y coordinates for height interpolation. The array must match Values in length. | | Values | (Nullable) Array of Number | The condition values at corresponding Positions entries. The array must match Positions in length. |
NoiseHeightThresholdValue
NoiseHeightThresholdValue with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Noise | This field controls the type, it must be set to the constant value "Noise" to function as this type. | | Noise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The noise that selects a nested height threshold. | | Keys | (Nullable) Array of Number | The ordered noise values mapped to Thresholds entries. The array must match Thresholds in length. | | Thresholds | (Nullable) Array of the type: IndexedHeightThresholdValue | The height thresholds corresponding by index to Keys entries. |
| The world-height profile that shapes this biome's terrain surface. |
| Layers | (Nullable)
LayerValue
LayerValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) String defaults to: | The block key used where no static or dynamic layer entry applies. | | Environment | (Nullable) String | The optional environment key assigned by the default layer. |
| The default block layer of this biome. WorldGenLayerAsset memberships supply the static and dynamic layers. |
| Tint | (Nullable)
TintValue
TintValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) TintDefaultValue | The tint selection used when no conditional entry matches. | | Entries | (Nullable) Array of the type: TintEntryValue | The ordered conditional tint selections. |
| The optional weighted color tints for this biome. |
| Environment | (Nullable)
EnvironmentValue
EnvironmentValue with the following properties:
| Key | Type | Description |
|---|
| Default | (Nullable) EnvironmentDefaultValue | The environment selection used when no conditional entry matches. | | Entries | (Nullable) Array of the type: EnvironmentEntryValue | The ordered conditional environment selections. |
| The optional weighted environment assignments for this biome. |
| Water | (Nullable) Array of the type:
WaterValue
WaterValue with the following properties:
| Key | Type | Description |
|---|
| SeedIndex | (Nullable) Integer | The preserved index used to replay the legacy water seed. Keep converted values unique and nonnegative. | | DirectEntry | Boolean defaults to: false | Whether this entry preserves the direct legacy seed path. The default is false. | | Block | (Nullable) String | The block generated by this water layer. | | Fluid | (Nullable) String | The fluid generated by this water layer. | | Min | (Nullable) Type 0 | The minimum absolute world Y range for this water layer. The default is zero. | | MinNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise that modifies the minimum world Y value. | | Max | (Nullable) Type 0 | The maximum absolute world Y range for this water layer. | | MaxNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise that modifies the maximum world Y value. | | NoiseMask | (Nullable) NoiseConditionValue | The optional noise condition for this water layer. |
| The ordered water or fluid layers generated in this biome. |
| Fade | (Nullable)
FadeValue
FadeValue with the following properties:
| Key | Type | Description |
|---|
| FadeStart | Number defaults to: 0.0 | The border distance where biome-mask fading begins, in blocks. The default is zero. | | FadeLength | Number defaults to: 0.0 | The border distance over which biome-mask fading occurs, in blocks. The default is zero. | | TerrainStart | Number defaults to: 0.0 | The border distance where terrain blending begins, in blocks. The default is zero. | | TerrainLength | Number defaults to: 0.0 | The border distance over which terrain blending occurs, in blocks. The default is zero. | | FadeHeightmap | Number | The heightmap level used for vertical fading. If absent, heightmap fading is disabled. |
| The optional border and terrain fading configuration. |
| HeightmapNoise | (Nullable) Either String or NoiseAssetReference to a NoiseAsset asset | The optional noise added to the biome terrain heightmap. |
| MapColor | (Nullable) String | The hexadecimal color used to display this biome on maps. The default is red. |
| Weight | Number defaults to: 1.0 | The relative selection weight of this tile biome. The default is 1. |
| SizeModifier | Number defaults to: 1.0 | The biome-size value stored by world generation assets. It currently does not change biome cell selection. |
| Tags | (Nullable) Map of the following:
Map
| Key | Type |
|---|
any String | Array of String |
| Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.
For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.
Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone. |
Types referenced by this type
Any of these:
| Type |
|---|
Number |
Array of Number |
Map of the following:
Map
| Key | Type |
|---|
any String | anything |
|
Any of these:
| Type |
|---|
Number |
Array of Number |
Array of Array of Number |
