HytaleDocs
Misc

StateFadeConfig

Duration

How long this subscriber's ramp takes, as bars plus beats plus ms against its own tempo. A subscriber with no tempo takes the Ms component alone. Categories, ambient beds and sound events never have one, so author their fades in Ms. A music container needs a Tempo of its own, or one inherited from the Segment it is a direct layer of. Omit to take the length the axis resolved.

Type information:

(Nullable)

BarBeatDuration with the following properties:

KeyTypeDescription
BarsInteger defaults to: 0
Beats(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Beats, which may be fractional. Against a quarter-note beat, 0.5 is an eighth and 1.5 a dotted quarter.

Ms(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Additional millisecond offset summed with bar/beat components. Allows pure ms authoring (e.g. { Ms: 1234 }) or fine-tuning bar/beat positions without a divide.

Curve

Interpolation curve shape. Read only when this fade supplies Duration. Alongside a Delay and no Duration it is ignored, and a Fade carrying nothing but a Curve is rejected.

Type information:

(Nullable) Any one of the following String (defaults to Linear):

NameDescription
"Linear"
"Logarithmic"
"Exponential"
"SCurve"
"EqualPowerSine"

Delay

How long this subscriber holds its old level past the boundary before its ramp starts. An audio category has no hold, so a delay lengthens its ramp instead. Non-negative: to begin before a boundary, move the boundary itself with SyncTo Offset.

Type information:

(Nullable)

BarBeatDuration with the following properties:

KeyTypeDescription
BarsInteger defaults to: 0
Beats(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Beats, which may be fractional. Against a quarter-note beat, 0.5 is an eighth and 1.5 a dotted quarter.

Ms(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Additional millisecond offset summed with bar/beat components. Allows pure ms authoring (e.g. { Ms: 1234 }) or fine-tuning bar/beat positions without a divide.

On this page