HytaleDocs
Misc

UniquePrefabConfigurationValue

HeightThreshold

The optional world-height condition for candidate locations.

Type information:

(Nullable) Either

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 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

IndexedHeightThresholdValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

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

Threshold(Nullable) Either BasicHeightThresholdValue or NoiseHeightThresholdValue

The height threshold selected at this noise key.

The height thresholds corresponding by index to Keys entries.

Mask

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

Type information:

(Nullable) Either String or BlockMask

Reference to a BlockMask asset

MaskCacheKey

The optional cache key shared by equivalent block masks.

Type information: (Nullable) String

Rotations

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

Type information: (Nullable) Array of String

BiomeMask

The optional biome rules allowed for placement.

Type information: (Nullable) Array of String

NoiseMask

The optional noise condition for placement.

Type information:

(Nullable)

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.

ParentBlocks

The optional Blocks mask key or inline asset that selects blocks and fluids below the prefab anchor.

Type information:

(Nullable) Either String or BlockMask

Reference to a BlockMask asset

Anchor

The prefab anchor offset in horizontal X and Z block coordinates.

Type information:

(Nullable)

Vector2Value with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0

The horizontal X component in blocks.

YNumber defaults to: 0.0

The horizontal Z component in blocks.

SpawnOffset

The X, Y, and Z block offset applied to the spawn point. The default is (0, -5000, 0).

Type information:

(Nullable)

Vector3Value with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0

The world X component in blocks.

YNumber defaults to: 0.0

The world Y component in blocks.

ZNumber defaults to: 0.0

The world Z component in blocks.

MaxDistance

The maximum placement distance from the anchor, in blocks. The default is 100.

Type information: Number defaults to: 100.0

FitHeightmap

Whether placement follows the terrain heightmap. The default is false.

Type information: Boolean defaults to: false

Submerge

Whether placement can extend below its surface anchor. The default is false.

Type information: Boolean defaults to: false

OnWater

Whether placement anchors to water surfaces. The default is false.

Type information: Boolean defaults to: false

Environment

The optional environment key assigned around the placed prefab.

Type information: (Nullable) String

MaxAttempts

The maximum candidate placements tested. The default is 5000.

Type information: (Nullable) Integer

ExclusionRadius

The minimum distance from other unique prefabs, in blocks. The default is 50.

Type information: Number defaults to: 50.0

IsSpawn

Whether this prefab defines the world spawn. The default is false.

Type information: Boolean defaults to: false

BorderExclusion

The minimum distance from a zone border, in blocks. The default is 25.

Type information: Number defaults to: 25.0

ShowOnMap

Whether the placed prefab appears on the map. The default is false.

Type information: Boolean defaults to: 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