HytaleDocs
Misc

BiomePrefabContent

Define a set of one or more prefabs that should be generated in the target biome(s)

Type

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

Type information: Constant value: BiomePrefab

Prefabs

Weighted list of prefab paths to randomly choose from

Type information:

(Nullable) Array of the type:

Entry with the following properties:

KeyTypeDescription
Path(Nullable) String defaults to:

The path of the prefab

WeightNumber defaults to: 1.0

The random chance of the path being chosen

BlockMask

The types of blocks that the prefab's blocks can replace

Type information:

(Nullable) Defines a block mask that filters which blocks and fluids can be replaced, using include and exclude rules to control placement targets

BlockMask with the following properties:

KeyTypeDescription
Include(Nullable)
Rule

Rule with the following properties:

KeyTypeDescription
AnyBoolean defaults to: false

Flag indicating the rule matches on any block or fluid

EmptyBoolean defaults to: false

Flag indicating the rule matches on the empty block

Blocks(Nullable) Array of the type: Either String or BlockType

Reference to a BlockType asset

List of blocks that this rule should match on

Fluids(Nullable) Array of the type: Either String or Fluid

Reference to a Fluid asset

List of fluids that this rule should match on

Set of block and fluid types that should be included by this mask

Exclude(Nullable)
Rule

Rule with the following properties:

KeyTypeDescription
AnyBoolean defaults to: false

Flag indicating the rule matches on any block or fluid

EmptyBoolean defaults to: false

Flag indicating the rule matches on the empty block

Blocks(Nullable) Array of the type: Either String or BlockType

Reference to a BlockType asset

List of blocks that this rule should match on

Fluids(Nullable) Array of the type: Either String or Fluid

Reference to a Fluid asset

List of fluids that this rule should match on

Set of block and fluid types that should be excluded by this mask

NoiseMask

The horizontal noise mask for the prefab placement position

Type information:

(Nullable) Defines a noise mask that uses fractal simplex noise to control placement density within a configurable threshold range

NoiseMask with the following properties:

KeyTypeDescription
Seed(Nullable) String defaults to: Default_Mask

Seed for the mask noise

ScaleNumber defaults to: 128.0

The scale of the mask noise

OctavesInteger defaults to: 2

The number of octaves of the noise to use

LacunarityNumber defaults to: 4.0

The cumulative frequency multiplier for each noise octave

PersistenceNumber defaults to: 0.6

The cumulative gain multiplier for each noise octave

Density(Nullable)
FloatRange

FloatRange with the following properties:

KeyTypeDescription
Min(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The inclusive minimum value of the range

Max(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The inclusive maximum value of the range

Threshold range for the mask. Noise values outside the range result in the prefab position being occluded

HeightMask

The height range mask for the prefab placement position

Type information:

(Nullable) Defines a height mask that restricts placement to a specific vertical range within the world

HeightMask with the following properties:

KeyTypeDescription
MinInteger defaults to: 0

The inclusive minimum height of the mask range

MaxInteger defaults to: 319

The inclusive maximum height of the mask range

OffsetY

The vertical offset for the prefab placement position

Type information: Integer defaults to: 0

Rotations

The rotation directions that the prefab can be randomly placed in

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"Rotation0"
"Rotation90"
"Rotation180"
"Rotation270"

Environment

The environment to place where the prefab is placed

Type information:

(Nullable) Environment

PointGrid

The point grid for the prefab

Type information:

(Nullable) Defines a point grid that distributes placement positions across the world using a seeded cell-based layout with configurable scale, jitter, and density

PointGrid with the following properties:

KeyTypeDescription
Seed(Nullable) String defaults to: Default_Grid

Seed for the point grid

ScaleNumber defaults to: 16.0

Scale of the point grid

JitterNumber defaults to: 0.75

Jitter of the points in the grid

Density(Nullable)
FloatRange

FloatRange with the following properties:

KeyTypeDescription
Min(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The inclusive minimum value of the range

Max(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The inclusive maximum value of the range

Density threshold for the point grid

FitHeightmap

Whether the prefab should fit to the heightmap

Type information: Boolean defaults to: false

Submerge

Whether the prefab should be submerged if placed underwater

Type information: Boolean defaults to: false

BaseChecks

List of prefab base-check rules

Type information:

(Nullable) Array of the type: Define additional height checks around the base of the prefab to prevent it placing on uneven ground

PrefabBaseCheck with the following properties:

KeyTypeDescription
BaseScale(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The size of the prefab's base as a proportion of its horizontal dimensions

PrefabSizeInteger defaults to: 20

The minimum size of the prefab that this base check applies to

HeightToleranceInteger defaults to: 2

The amount of terrain height difference allowed around the prefab's base before the location is deemed too uneven

ParentMask

Define which blocks the prefab can be placed on

Type information:

(Nullable) Defines a block mask that filters which blocks and fluids can be replaced, using include and exclude rules to control placement targets

BlockMask with the following properties:

KeyTypeDescription
Include(Nullable)
Rule

Rule with the following properties:

KeyTypeDescription
AnyBoolean defaults to: false

Flag indicating the rule matches on any block or fluid

EmptyBoolean defaults to: false

Flag indicating the rule matches on the empty block

Blocks(Nullable) Array of the type: Either String or BlockType

Reference to a BlockType asset

List of blocks that this rule should match on

Fluids(Nullable) Array of the type: Either String or Fluid

Reference to a Fluid asset

List of fluids that this rule should match on

Set of block and fluid types that should be included by this mask

Exclude(Nullable)
Rule

Rule with the following properties:

KeyTypeDescription
AnyBoolean defaults to: false

Flag indicating the rule matches on any block or fluid

EmptyBoolean defaults to: false

Flag indicating the rule matches on the empty block

Blocks(Nullable) Array of the type: Either String or BlockType

Reference to a BlockType asset

List of blocks that this rule should match on

Fluids(Nullable) Array of the type: Either String or Fluid

Reference to a Fluid asset

List of fluids that this rule should match on

Set of block and fluid types that should be excluded by this mask

On this page