HytaleDocs

ResponseCurves

Asset path: Server/ResponseCurves/*.json

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

All possible options are listed below:

Exponential

An response curve which changes at an exponential rate.

ExponentialResponseCurve with the following properties:

KeyTypeDescription
TypeConstant value: Exponential

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

ParentString

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

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

SlopeNumber defaults to: 1.0

The slope of the curve.

ExponentNumber defaults to: 1.0

The exponent used to generate this curve. 1 is linear, 2 results in a quadratic parabola, and 3 in a cubic curve, etc.

HorizontalShiftNumber defaults to: 0.0

The horizontal shift to apply to the curve. This decides how far the curve is shifted left or right along the x axis.

VerticalShiftNumber defaults to: 0.0

The vertical shift to apply to the curve. This decides how far the curve is shifted up or down along the y axis.

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.

Logistic

A response curve with a logistic rate of change.

LogisticResponseCurve with the following properties:

KeyTypeDescription
TypeConstant value: Logistic

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

ParentString

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

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

RateOfChangeNumber defaults to: 1.0

The rate of change of the curve - similar to Slope in the exponential curve.

CeilingNumber defaults to: 1.0

The total height of the curve between its two plateaus. Using a negative value with vertical offsets allows the curve to act as a diminishing factor

HorizontalShiftNumber defaults to: 0.5

The horizontal shift to apply to the curve. This decides how far the curve is shifted left or right along the x axis.

VerticalShiftNumber defaults to: 0.0

The vertical shift to apply to the curve. This decides how far the curve is shifted up or down along the y axis.

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.

SineWave

A response curve with a sine wave shape.

SineWaveResponseCurve with the following properties:

KeyTypeDescription
TypeConstant value: SineWave

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

ParentString

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

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

AmplitudeNumber defaults to: 1.0

The vertical distance between the horizontal axis and the max/min value of the function.

FrequencyNumber defaults to: 0.5

The frequency of the sine wave's repetition (e.g. set to 1, the full pattern will appear once in the 0-1 range, twice with 2, etc).

HorizontalShiftNumber defaults to: 0.0

The horizontal shift to apply to the curve,. This decides how far the curve is shifted left or right along the x axis.

VerticalShiftNumber defaults to: 0.0

The vertical shift to apply to the curve. This decides how far the curve is shifted up or down along the y axis.

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.

Switch

A type of response curve which returns the initial state value before the defined switch point and the final state value after reaching it.

SwitchResponseCurve with the following properties:

KeyTypeDescription
TypeConstant value: Switch

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

ParentString

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

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

InitialStateNumber defaults to: 0.0

The y value to return before the switch point.

FinalStateNumber defaults to: 1.0

The y value to return at and beyond the switch point.

SwitchPointNumber defaults to: 0.0

The value at which to switch from the initial state to the final state.

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