HytaleDocs
WorldGen

Layers

Asset path: Server/WorldGen/Layers/*.json

This object has different properties depending on the value of the Type property.

All possible options are listed below:

Dynamic

DynamicLayerAsset with the following properties:

KeyTypeDescription
TypeConstant value: Dynamic

This field controls the type, it must be set to the constant value "Dynamic" to function as this type.

ParentString

When set this asset will inherit properties from the named asset.

When inheriting from another DynamicLayerAsset 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.

DirectEntryBoolean defaults to: false

Whether this layer preserves the direct legacy seed path. When true, Entries must contain exactly one item.

NoiseMask(Nullable)
NoiseConditionValue

NoiseConditionValue with the following properties:

KeyTypeDescription
Noise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise evaluated by this condition.

Threshold(Nullable) Type 0

The accepted noise value or ranges.

The optional noise condition for this layer.

Environment(Nullable) String

The optional environment key assigned by this layer.

Biomes(Nullable) Array of the type:
LayerBiomeMembership

LayerBiomeMembership with the following properties:

KeyTypeDescription
Biome(Nullable) String that matches the pattern: [^\s] and is at least 1 characters long defaults to:

Reference to a WorldGenBiomeAsset asset

The required exact WorldGenBiomeAsset key for this placement.

OrderInteger

The nonnegative converter position among this parent's layers of the same Type. It is honored only when ConvertedPin is true.

ConvertedPinBoolean defaults to: false

Whether Order and SeedIndex preserve converted placement identities. The default is false.

SeedIndexInteger

The nonnegative legacy seed index. It is honored only when ConvertedPin is true.

The inherited biome placements. An explicit array replaces all inherited memberships. Repeated parents declare separate occurrences.

Entries(Nullable) Array of the type:
DynamicLayerEntryValue

DynamicLayerEntryValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The preserved index used to replay the legacy dynamic-entry seed. Keep converted values unique and nonnegative.

Blocks(Nullable) NoiseBlockArrayValue

The optional ordered block sequence generated by this entry.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for this dynamic entry.

The ordered dynamic-layer entries. The first active entry wins.

Offset(Nullable) Type 2

The random vertical offset from terrain height, in blocks. The default is zero.

OffsetNoise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that modifies the vertical offset.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray 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.

Static

StaticLayerAsset with the following properties:

KeyTypeDescription
TypeConstant value: Static

This field controls the type, it must be set to the constant value "Static" to function as this type.

ParentString

When set this asset will inherit properties from the named asset.

When inheriting from another StaticLayerAsset 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.

DirectEntryBoolean defaults to: false

Whether this layer preserves the direct legacy seed path. When true, Entries must contain exactly one item.

NoiseMask(Nullable)
NoiseConditionValue

NoiseConditionValue with the following properties:

KeyTypeDescription
Noise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise evaluated by this condition.

Threshold(Nullable) Type 0

The accepted noise value or ranges.

The optional noise condition for this layer.

Environment(Nullable) String

The optional environment key assigned by this layer.

Biomes(Nullable) Array of the type:
LayerBiomeMembership

LayerBiomeMembership with the following properties:

KeyTypeDescription
Biome(Nullable) String that matches the pattern: [^\s] and is at least 1 characters long defaults to:

Reference to a WorldGenBiomeAsset asset

The required exact WorldGenBiomeAsset key for this placement.

OrderInteger

The nonnegative converter position among this parent's layers of the same Type. It is honored only when ConvertedPin is true.

ConvertedPinBoolean defaults to: false

Whether Order and SeedIndex preserve converted placement identities. The default is false.

SeedIndexInteger

The nonnegative legacy seed index. It is honored only when ConvertedPin is true.

The inherited biome placements. An explicit array replaces all inherited memberships. Repeated parents declare separate occurrences.

Entries(Nullable) Array of the type:
StaticLayerEntryValue

StaticLayerEntryValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The preserved index used to replay the legacy static-entry seed. Keep converted values unique and nonnegative.

Blocks(Nullable) NoiseBlockArrayValue

The optional ordered block sequence generated by this entry.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for this static entry.

Min(Nullable) Type 3

The minimum absolute world Y range for this static entry.

MinNoise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that modifies the minimum world Y value.

Max(Nullable) Type 3

The maximum absolute world Y range for this static entry.

MaxNoise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that modifies the maximum world Y value.

The ordered static-layer entries. The first active entry wins.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray 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.

Notes:

Types referenced by this type

Type 0

Any of these:

Type
Number
Array of Number
Type 1

Type 1

Any of these:

Type
Number
Array of Number
Array of Array of Number

Type 2

Any of these:

Type
Number
Array of Number
Map of the following:
Map
KeyType
any Stringanything

Type 3

Any of these:

Type
Number
Array of Number
Map of the following:
Map
KeyType
any Stringanything

On this page