HytaleDocs
WorldGen

BlockMasks

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

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

All possible options are listed below:

Blocks

Blocks with the following properties:

KeyTypeDescription
TypeConstant value: Blocks

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

ParentString

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

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

Blocks(Nullable) Array of the type:
Block

Block with the following properties:

KeyTypeDescription
Block(Nullable) String

The block key matched by this entry. At least Block or Fluid is required.

Fluid(Nullable) String

The fluid key matched by this entry. At least Block or Fluid is required.

The ordered block and fluid pairs matched by this selection. An empty array matches nothing.

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.

Replacement

Replacement with the following properties:

KeyTypeDescription
TypeConstant value: Replacement

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

ParentString

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

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

Default(Nullable) Array of the type:
ReplacementRule

ReplacementRule with the following properties:

KeyTypeDescription
Block(Nullable) String

The target block key matched by this rule, including its variants.

Fluid(Nullable) String

The target fluid key matched by this rule.

WildcardBoolean defaults to: false

Whether this rule matches remaining targets after explicit rules. The default is false.

ReplaceBoolean defaults to: true

Whether this rule allows replacement. The default is true. The first matching explicit rule takes precedence.

The ordered fallback rules. If absent, targets with an empty block or fluid are allowed.

Specific(Nullable) Array of the type:
Specific

Specific with the following properties:

KeyTypeDescription
Blocks(Nullable) Array of the type: Block

The source blocks or fluids that select this rule group. Block variants also select this group.

Rule(Nullable) Array of the type: ReplacementRule

The ordered replacement rules for the selected source blocks or fluids.

The rule groups selected by source blocks or fluids. Later groups override earlier groups for the same source.

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.

On this page