HytaleDocs
WorldGen

Covers

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

Parent

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

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

Type information: String

Tags

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.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Biomes

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

Type information:

(Nullable) Array of the type:

CoverBiomeMembership with the following properties:

KeyTypeDescription
SeedIndexInteger

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

Blocks(Nullable) Array of the type:
CoverBlockValue

CoverBlockValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

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

Block(Nullable) String

The block placed by this weighted cover entry.

Fluid(Nullable) String

The fluid placed by this weighted cover entry.

WeightNumber defaults to: 1.0

The relative selection weight of this cover entry. The default is 1.

Offset(Nullable) Integer

The vertical placement offset in blocks. The default is zero.

The weighted blocks or fluids placed by this cover.

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

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.

DensityNumber defaults to: 1.0

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

OnWaterBoolean defaults to: false

Whether this cover anchors to water surfaces. The default is false.

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 within this parent. It is honored only when ConvertedPin is true.

ConvertedPinBoolean defaults to: false

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

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

On this page