HytaleDocs
Misc

CavePrefabValue

SeedIndex

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

Type information: (Nullable) Integer

Prefab

The prefab references available to this entry.

Type information: (Nullable) Array of String

Weight

The selection weights corresponding by index to Prefab entries. The default weight is 1.

Type information: (Nullable) Array of Number

Config

The placement configuration for this cave-prefab entry.

Type information:

(Nullable)

CavePrefabConfigValue with the following properties:

KeyTypeDescription
Rotations(Nullable) Array of String

The allowed prefab rotations. If absent, all rotations are allowed.

Placement(Nullable) String

The cave surface used for prefab placement. The default is the cave placement default.

BiomeMask(Nullable) Array of String

The optional biome rules allowed for cave-prefab placement.

Mask(Nullable) Either String or BlockMask

Reference to a BlockMask asset

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

MaskCacheKey(Nullable) String

The optional cache key shared by equivalent placement masks.

Iterations(Nullable) Type 0

The random number of placement attempts. The default is 5.

Displacement(Nullable) Type 0

The random coordinate displacement in blocks. The default is zero.

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 1

The accepted noise value or ranges.

The optional noise condition for placement.

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 for placement.

Notes:

Types referenced by this type

Type 0

Any of these:

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

Type 1

Any of these:

Type
Number
Array of Number
Type 2

Type 2

Any of these:

Type
Number
Array of Number
Array of Array of Number

On this page