HytaleDocs
Misc

MultiplyNoiseAsset

Type

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

Type information: Constant value: MULTIPLY

Parent

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

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

Seed

The seed label used by leaf noise functions. If absent, the parent seed is used.

Type information: (Nullable) String

Noise

The ordered child noises used by this noise operation.

Type information:

(Nullable) Either Either String or NoiseAsset

Reference to a NoiseAsset asset or Array of the type: Either String or NoiseAsset

Reference to a NoiseAsset asset

Alpha

The noise that selects entries for BLEND noise.

Type information:

(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

NoiseLookup

The optional noise sampled by CELL lookup modes.

Type information:

(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

Factors

The SUM multipliers corresponding by index to Noise entries.

Type information: (Nullable) Array of Number

Thresholds

The strictly increasing BLEND thresholds corresponding by index to Noise entries.

Type information: (Nullable) Array of Number

Formula

The formula used by FORMULA noise or applied as an output wrapper to other noise types.

Type information: (Nullable) String

Curve

The optional power curve applied to this noise output.

Type information:

(Nullable)

NoiseCurveAsset with the following properties:

KeyTypeDescription
ANumber defaults to: 2.0

The first power-curve parameter. The default is 2.

BNumber defaults to: -2.0

The second power-curve parameter. The default is -2.

Scale

The coordinate scale applied to this noise. If absent, coordinates are not scaled.

Type information: Number

Normalize

The output range for the optional normalization wrapper. For GRADIENT noise, the first value is the magnitude divisor, which defaults to 0.1.

Type information:

(Nullable) Any of these:

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

Range

The source range mapped to zero through one by NORMALIZE noise.

Type information:

(Nullable) Any of these:

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

Offset

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

Type information: Number

OffsetX

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

Type information: Number

OffsetY

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

Type information: Number

OffsetZ

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

Type information: Number

Pitch

The coordinate pitch in degrees for the optional rotation wrapper.

Type information: Number

Yaw

The coordinate yaw in degrees for the optional rotation wrapper.

Type information: Number

OriginX

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

Type information: Number

OriginY

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

Type information: Number

OriginZ

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

Type information: Number

Rotate

The coordinate rotation used by ROTATE noise. ROTATE requires this field.

Type information:

(Nullable)

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

Gradient

The optional gradient transformation applied to this noise output.

Type information:

(Nullable)

NoiseGradientAsset with the following properties:

KeyTypeDescription
Mode(Nullable) String defaults to: MAGNITUDE

The gradient calculation mode. The default is MAGNITUDE.

DistanceNumber defaults to: 5.0

The gradient sampling distance in blocks. The default is 5.

NormalizeNumber defaults to: 0.1

The divisor applied to the gradient magnitude. The default is 0.1.

Randomizer

The coordinate distortion used by DISTORTED noise. DISTORTED requires this field.

Type information:

(Nullable)

NoiseCoordinateRandomizerAsset with the following properties:

KeyTypeDescription
Generators(Nullable) Array of the type:
NoiseGeneratorAsset

NoiseGeneratorAsset with the following properties:

KeyTypeDescription
Noise(Nullable) Either String or NoiseAsset

Reference to a NoiseAsset asset

The noise sampled for each coordinate-axis distortion.

AmplitudeNumber defaults to: 0.0

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

The distortion generators applied independently to X, Y, and Z coordinates.

Rotate(Nullable)
NoiseCoordinateRotatorAsset

NoiseCoordinateRotatorAsset 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 distortion.

Octaves

The number of fractal octaves. If absent, the leaf uses one octave.

Type information: (Nullable) Integer

FractalMode

The fractal combination mode used when Octaves is present. The default is FBM.

Type information: (Nullable) String

Lacunarity

The frequency multiplier between fractal octaves. The default is 2.

Type information: Number

Persistence

The amplitude multiplier between fractal octaves. The default is 0.5.

Type information: Number

Value

The output of CONSTANT noise. The default is 0.5.

Type information: Number

CellMode

The value returned for each CELL region. The default is CELL_VALUE.

Type information: (Nullable) String

CellType

The cell geometry used by CELL, DISTANCE, MESH, and related noises. The default is SQUARE.

Type information: (Nullable) String

DistanceMode

The point-distance formula used by cell evaluators. The default is EUCLIDEAN.

Type information: (Nullable) String

Distance2Mode

The operation combining two nearest distances in DISTANCE noise. The default is SUB.

Type information: (Nullable) String

Measurement

The DISTANCE measurement source. The default is CENTRE_DISTANCE.

Type information: (Nullable) String

Jitter

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

Type information: Number

JitterX

The X-axis cell-point jitter, overriding Jitter for that axis.

Type information: Number

JitterY

The Y-axis cell-point jitter, overriding Jitter for that axis.

Type information: Number

JitterZ

The Z-axis cell-point jitter, overriding Jitter for that axis.

Type information: Number

Density

The optional threshold controlling which cell points are active.

Type information:

(Nullable) Any of these:

Type
Number
Array of Number
Array of Array of Number

DistanceRange

The optional random range added to evaluated cell distances.

Type information:

(Nullable) Any of these:

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

Skip

The number of nearer cell points skipped during evaluation. The default is zero.

Type information: (Nullable) Integer

SkipMode

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

Type information: (Nullable) String

Thickness

The common line thickness used by GRID or MESH noise.

Type information: Number

ThicknessX

The X-axis GRID line thickness, overriding Thickness.

Type information: Number

ThicknessY

The Y-axis GRID line thickness, overriding Thickness.

Type information: Number

ThicknessZ

The Z-axis GRID line thickness, overriding Thickness. The fallback is zero.

Type information: Number

X

The world X coordinate of the POINT noise center. The default is zero.

Type information: Number

Y

The world Y coordinate of the POINT noise center. The default is zero.

Type information: Number

Z

The world Z coordinate of the POINT noise center. The default is zero.

Type information: Number

InnerRadius

The inner radius of POINT noise in blocks. The default is zero.

Type information: Number

OuterRadius

The outer radius of POINT noise in blocks. The default is zero.

Type information: Number

A

The first power-curve parameter for CURVE noise. The default is 2.

Type information: Number

B

The second power-curve parameter for CURVE noise. The default is -2.

Type information: Number

Mode

The gradient calculation mode for GRADIENT noise. The default is MAGNITUDE.

Type information: (Nullable) String

Distance

The sampling distance used by GRADIENT noise. The default is 5 blocks.

Type information: Number

InterpolationMode

The interpolation used by PERLIN and VALUE noise. The default is QUINTIC.

Type information: (Nullable) String

LinesX

Whether HEX MESH noise includes X-oriented lines. The default is true.

Type information: Boolean

LinesY

Whether HEX MESH noise includes Y-oriented lines. The default is true.

Type information: Boolean

LinesZ

Whether HEX MESH noise includes Z-oriented lines. The default is true.

Type information: Boolean

ParentType

The parent-cell geometry used by BRANCH noise. The default is SQUARE.

Type information: (Nullable) String

ParentDistanceMode

The parent point-distance formula used by BRANCH noise. The default is EUCLIDEAN.

Type information: (Nullable) String

ParentDistanceType

The operation combining parent distances in BRANCH noise. The default is DIV.

Type information: (Nullable) String

ParentFormula

The formula applied to parent distances in BRANCH noise. The default is SQRT.

Type information: (Nullable) String

ParentJitter

The common parent-cell jitter in BRANCH noise. The default is 1.

Type information: Number

ParentJitterX

The X-axis parent-cell jitter, overriding ParentJitter.

Type information: Number

ParentJitterY

The Y-axis parent-cell jitter, overriding ParentJitter.

Type information: Number

ParentValue

The base parent-cell value for BRANCH noise. The default is zero.

Type information: Number

ParentFade

The random fade distance around BRANCH parent cells. The default is zero.

Type information:

(Nullable) Any of these:

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

ParentDensity

The optional condition controlling which BRANCH parent cells are active.

Type information:

(Nullable) Any of these:

Type
Number
Array of Number
Type 0

LineType

The branch-line cell geometry used by BRANCH noise. The default is SQUARE.

Type information: (Nullable) String

LineDirection

The direction branches extend from parent cells. The default is OUTWARD.

Type information: (Nullable) String

LineScale

The coordinate scale of branch lines. The default is 0.1.

Type information: Number

LineJitter

The common branch-line jitter. The default is 1.

Type information: Number

LineJitterX

The X-axis branch-line jitter, overriding LineJitter.

Type information: Number

LineJitterY

The Y-axis branch-line jitter, overriding LineJitter.

Type information: Number

LineThickness

The random branch-line thickness. The default is 0.1.

Type information:

(Nullable) Any of these:

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

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

Notes:

Types referenced by this type

Type 0

Any of these:

Type
Number
Array of Number
Array of Array of Number

On this page