HytaleDocs
WorldGen

ClimateMasks

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

Parent

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

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

Randomizer

The optional coordinate displacement applied before climate 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.

Noise

The continent, temperature, and intensity noise configuration.

Type information:

(Nullable)

ClimateNoiseValue with the following properties:

KeyTypeDescription
Grid(Nullable)
ClimateGridValue

ClimateGridValue with the following properties:

KeyTypeDescription
Seed(Nullable) String

The grid seed label. If absent, the parent seed is used.

ScaleNumber defaults to: 1.0

The coordinate scale of the climate grid. The default is 1.

JitterNumber defaults to: 0.8

The displacement of climate grid points. The default is 0.8.

The climate sampling grid. If absent, an unscaled direct grid with seed zero is used.

Thresholds(Nullable)
ContinentThresholdsValue

ContinentThresholdsValue with the following properties:

KeyTypeDescription
LandNumber defaults to: 0.5

The continent-noise boundary for mainland. The default is 0.5.

IslandNumber defaults to: 0.8

The continent-noise boundary for islands. The default is 0.8.

BeachSizeNumber defaults to: 0.05

The continent-noise width assigned to beaches. The default is 0.05.

ShallowOceanSizeNumber defaults to: 0.15

The continent-noise width assigned to shallow ocean. The default is 0.15.

The noise thresholds separating land, islands, beaches, shallow ocean, and ocean.

Continent(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise asset that determines continent and ocean regions.

Temperature(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise asset that determines the climate temperature coordinate.

Intensity(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise asset that determines the climate intensity coordinate.

Climate

The climate graph that maps sampled noise values to mask colors.

Type information:

(Nullable)

ClimateGraphValue with the following properties:

KeyTypeDescription
FadeMode(Nullable) String defaults to: CHILDREN

The climate graph nodes included in fades. The default is CHILDREN.

FadeRadiusNumber defaults to: 50.0

The climate-space radius blended around graph points. The default is 50.

FadeDistanceNumber defaults to: 100.0

The climate-space distance used for graph transitions. The default is 100.

Climates(Nullable) Array of the type:
ClimateTypeValue

ClimateTypeValue with the following properties:

KeyTypeDescription
Name(Nullable) String defaults to:

The climate node name used for diagnostics and child paths.

Color(Nullable) ClimateColorValue

The mask colors for mainland regions. Missing color channels inherit from the parent node.

Island(Nullable) ClimateColorValue

The mask colors for island regions. If absent, Color is used.

Points(Nullable) Array of the type: ClimatePointValue

The temperature and intensity points assigned to this climate node.

Children(Nullable) Array of the type: ClimateTypeValue

The child climate nodes evaluated below this node.

The ordered root nodes of the climate graph. The default is an empty array.

UniqueZones

The optional isolated zones placed by climate rules.

Type information:

(Nullable) Array of the type:

UniqueZoneValue with the following properties:

KeyTypeDescription
Name(Nullable) String defaults to:

The unique-zone name used to resolve its mapped zone.

Parent(Nullable) String defaults to:

The optional parent climate name that limits placement.

Color(Nullable) String defaults to:

The hexadecimal mask color emitted for this unique zone.

Radius(Nullable) Integer

The unique-zone radius in horizontal blocks. The default is 8.

OriginX(Nullable) Integer

The X offset from the generated zone center, in blocks. The default is 8.

OriginY(Nullable) Integer

The Z offset from the generated zone center, in blocks. The default is 8.

MinDistance(Nullable) Integer

The minimum horizontal distance between generated centers, in blocks. The default is 100.

Distance(Nullable) Integer

The maximum search distance for generated centers, in blocks. The default is 5000.

Rule(Nullable)
ClimateRuleValue

ClimateRuleValue with the following properties:

KeyTypeDescription
Continent(Nullable) ClimateRangeValue

The optional continent-noise target range for this rule.

Temperature(Nullable) ClimateRangeValue

The optional temperature target range for this rule.

Intensity(Nullable) ClimateRangeValue

The optional intensity target range for this rule.

Fade(Nullable) ClimateRangeValue

The optional fade target range for this rule.

The climate-space rule controlling unique-zone placement.

On this page