HytaleDocs
WorldGen

Worlds

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

Parent

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

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

Width

The horizontal X extent used to scale image masks, in blocks.

Type information: Integer defaults to: 0

Height

The horizontal Z extent used to scale image masks, in blocks.

Type information: Integer defaults to: 0

OffsetX

The world X offset applied to image masks, in blocks. The default is zero.

Type information: Integer defaults to: 0

OffsetY

The world Z offset applied to image masks, in blocks. The default is zero.

Type information: Integer defaults to: 0

Randomizer

The optional coordinate displacement applied before mask sampling.

Type information:

(Nullable)

CoordinateRandomizerValue with the following properties:

KeyTypeDescription
Generators(Nullable) Array of the type:
RandomizerGeneratorValue

RandomizerGeneratorValue with the following properties:

KeyTypeDescription
SeedIndex(Nullable) Integer

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

Noise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise sampled for coordinate displacement.

AmplitudeNumber defaults to: 0.0

The maximum coordinate displacement produced by this generator, in blocks.

The ordered noise generators that displace world coordinates.

Rotate(Nullable)
CoordinateRotatorValue

CoordinateRotatorValue with the following properties:

KeyTypeDescription
PitchNumber defaults to: 0.0

The coordinate pitch in degrees. The default is zero.

YawNumber defaults to: 0.0

The coordinate yaw in degrees. The default is zero.

OriginXNumber defaults to: 0.0

The world X coordinate of the rotation pivot. The default is zero.

OriginYNumber defaults to: 0.0

The world Y coordinate of the rotation pivot. The default is zero.

OriginZNumber defaults to: 0.0

The world Z coordinate of the rotation pivot. The default is zero.

The optional rotation applied after coordinate displacement.

Masks

The weighted masks used to assign zone colors. Exactly one mask is selected from this map using the world seed.

Type information:

(Nullable) Array of the type:

WeightedMaskValue with the following properties:

KeyTypeDescription
WeightNumber defaults to: 1.0

The relative probability of selecting this mask. The default is 1.

Mask(Nullable) Either
ClimateMaskValue

ClimateMaskValue with the following properties:

KeyTypeDescription
TypeConstant value: ClimateMask

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

Asset(Nullable) String defaults to:

Reference to a ClimateMaskAsset asset

The ClimateMask asset key used to generate zone colors.

or
ImageMaskValue

ImageMaskValue with the following properties:

KeyTypeDescription
TypeConstant value: Image

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

Resource(Nullable) String defaults to:

The Server asset path of the image used as a zone mask.

The image or climate mask used by this weighted entry.

ZonePattern

The point generator used to distribute zones within each mask color.

Type information:

(Nullable)

PointGeneratorValue with the following properties:

KeyTypeDescription
Seed(Nullable) String

The seed label for candidate-point generation. If absent, the parent seed is used.

ScaleNumber

The coordinate scale of the point grid. If absent, the grid is not scaled.

Randomizer(Nullable)
CoordinateRandomizerValue

CoordinateRandomizerValue with the following properties:

KeyTypeDescription
Generators(Nullable) Array of the type: RandomizerGeneratorValue

The ordered noise generators that displace world coordinates.

Rotate(Nullable) CoordinateRotatorValue

The optional rotation applied after coordinate displacement.

The optional noise-based displacement of candidate points.

OffsetNumber

The common coordinate offset for all axes. The default is zero.

OffsetXNumber

The X-coordinate offset, overriding Offset for the X axis.

OffsetYNumber

The Y-coordinate offset, overriding Offset for the Y axis.

OffsetZNumber

The Z-coordinate offset, overriding Offset for the Z axis.

Rotate(Nullable)
CoordinateRotatorValue

CoordinateRotatorValue with the following properties:

KeyTypeDescription
PitchNumber defaults to: 0.0

The coordinate pitch in degrees. The default is zero.

YawNumber defaults to: 0.0

The coordinate yaw in degrees. The default is zero.

OriginXNumber defaults to: 0.0

The world X coordinate of the rotation pivot. The default is zero.

OriginYNumber defaults to: 0.0

The world Y coordinate of the rotation pivot. The default is zero.

OriginZNumber defaults to: 0.0

The world Z coordinate of the rotation pivot. The default is zero.

The optional coordinate rotation applied to the point grid.

CellType(Nullable) String

The point-grid cell geometry. The default is SQUARE.

DistanceMode(Nullable) String

The point-distance formula. The default is EUCLIDEAN.

Density(Nullable) Type 0

The optional condition controlling which candidate points remain active.

DistanceRange(Nullable) Type 1

The optional random modifier added to candidate-point distances.

Skip(Nullable) Integer

The number of nearer candidate points skipped. The default is zero.

SkipMode(Nullable) String

The strategy used to skip candidate points. The default is CHECKERBOARD.

JitterNumber

The common candidate-point jitter for all axes. The default is 1.

JitterXNumber

The X-axis point jitter, overriding Jitter.

JitterYNumber

The Y-axis point jitter, overriding Jitter.

JitterZNumber

The Z-axis point jitter, overriding Jitter.

Notes:

Types referenced by this type

Type 0

Any of these:

Type
Number
Array of Number
Array of Array of Number

Type 1

Any of these:

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

On this page