HytaleDocs
WorldGen

CaveNodes

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

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

All possible options are listed below:

CYLINDER

CylinderAsset with the following properties:

KeyTypeDescription
TypeConstant value: CYLINDER

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Radius(Nullable) Type 1

The random end radius in blocks. The default is 3.

MiddleRadius(Nullable) Type 1

The optional random middle radius in blocks.

Length(Nullable) Type 1

The random node length in blocks. The default range is 5 through 15.

InheritParentRadiusBoolean defaults to: true

Whether the shape starts with its parent radius. The default is true.

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.

DISTORTED

DistortedAsset with the following properties:

KeyTypeDescription
TypeConstant value: DISTORTED

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Shape(Nullable) String

The distorted shape factory name. If absent, the default factory is used.

Width(Nullable) Type 1

The random shape width in blocks. RadiusX overrides this field.

Height(Nullable) Type 1

The random shape height in blocks. RadiusY overrides this field.

MiddleWidth(Nullable) Type 1

The optional random middle width in blocks.

MiddleHeight(Nullable) Type 1

The optional random middle height in blocks.

Length(Nullable) Type 1

The optional random shape length in blocks. RadiusZ overrides this field.

RadiusX(Nullable) Type 1

The random X radius in blocks, overriding Width.

RadiusY(Nullable) Type 1

The random Y radius in blocks, overriding Height.

RadiusZ(Nullable) Type 1

The random Z radius in blocks, overriding Length.

InheritParentRadiusBoolean defaults to: true

Whether the shape starts with its parent radius. The default is true.

Distortion(Nullable)
ShapeDistortionValue

ShapeDistortionValue with the following properties:

KeyTypeDescription
Width(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that distorts shape width.

Floor(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that distorts the shape floor.

Ceiling(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The optional noise that distorts the shape ceiling.

The optional noises that distort the shape width, floor, and ceiling.

Interpolation(Nullable) String

The shape interpolation mode. The default is LINEAR.

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.

ELLIPSOID

EllipsoidAsset with the following properties:

KeyTypeDescription
TypeConstant value: ELLIPSOID

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Radius(Nullable) Type 1

The common random radius for all axes, in blocks. When present, it overrides RadiusX, RadiusY, and RadiusZ.

RadiusX(Nullable) Type 1

The random X radius in blocks. It is required when Radius is absent.

RadiusY(Nullable) Type 1

The random Y radius in blocks. It is required when Radius is absent.

RadiusZ(Nullable) Type 1

The random Z radius in blocks. It is required when Radius is absent.

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.

EMPTY_LINE

EmptyLineAsset with the following properties:

KeyTypeDescription
TypeConstant value: EMPTY_LINE

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Length(Nullable) Type 1

The random empty-line length in blocks. The default is zero.

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.

PIPE

PipeAsset with the following properties:

KeyTypeDescription
TypeConstant value: PIPE

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Radius(Nullable) Type 1

The random end radius in blocks. The default is 3.

MiddleRadius(Nullable) Type 1

The optional random middle radius in blocks.

Length(Nullable) Type 1

The random node length in blocks. The default range is 5 through 15.

InheritParentRadiusBoolean defaults to: true

Whether the shape starts with its parent radius. The default is true.

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.

PREFAB

PrefabAsset with the following properties:

KeyTypeDescription
TypeConstant value: PREFAB

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

ParentString

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

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

The generation seed label. Preserve converted values. Omitted values inherit only for same-key overlays. Different-key assets retain their own seed identity.

Children(Nullable) Array of the type: ChildValue

The ordered child-node placement entries inherited by this node.

Prefabs(Nullable)
PrefabContainerValue

PrefabContainerValue with the following properties:

KeyTypeDescription
Entries(Nullable) Array of the type: CavePrefabValue

The cave-prefab entries available to this node.

The optional cave-prefab population inherited by this node.

Filling(Nullable) Type 0

The weighted blocks or fluids used to fill the carved node. The default is empty space.

HeightThreshold(Nullable) Either
BasicHeightThresholdValue

BasicHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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.

or
NoiseHeightThresholdValue

NoiseHeightThresholdValue with the following properties:

KeyTypeDescription
TypeConstant 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 NoiseAsset

Reference 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 optional world-height condition inherited by this node.

ChildCountBounds(Nullable) Type 1

The optional random bounds on child placements inherited by this node.

Covers(Nullable) Array of the type:
CaveCoverValue

CaveCoverValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

The optional preserved index used to replay the legacy cover seed. Keep present values unique and nonnegative.

Blocks(Nullable) Array of the type: CaveCoverBlockValue

The weighted blocks or fluids placed by this cave cover.

HeightThreshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The optional world-height condition for cave-cover placement.

NoiseMask(Nullable) NoiseConditionValue

The optional noise condition for cave-cover placement.

DensityNumber defaults to: 1.0

The probability of placing this cover at an eligible coordinate. The default is 1.

Parent(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Blocks mask key or inline asset that selects substrate blocks and fluids below this cover.

AnchorType(Nullable) String

The cave surface used as the cover anchor. The default is FLOOR.

The ordered surface-cover entries inherited by this node.

Priority(Nullable) Integer

The cave-node processing priority inherited by this node. The default is zero.

Environment(Nullable) String

The optional environment key inherited by this node.

Prefab(Nullable) Array of String

The prefab references used to carve this cave node. At least one reference must resolve.

Mask(Nullable) Either String or BlockMask

Reference to a BlockMask asset

The optional Replacement block mask key or inline asset used for prefab carving.

MaskCacheKey(Nullable) String

The optional cache key shared by equivalent prefab masks.

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
String
Array of the type: Either String or Map of the following:
Map
KeyType
any Stringanything
Map of the following:
Map
KeyType
any Stringanything

Type 1

Any of these:

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

On this page