HytaleDocs
Misc

MusicSyncConfig

Point

Which boundary to wait for: Immediate, NextBeat, NextBar, ExitMarker, or NextMarker.

Type information:

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

NameDescription
"Immediate"
"NextBeat"
"NextBar"
"ExitMarker"
"NextMarker"

Marker

Marker name to sync to. Only used with Point: NextMarker. Omit to take the next marker of any name.

Type information: (Nullable) String

Offset

Signed offset from the boundary, as bars + beats + ms. Negative fires early, for lead-in material or to land on the last bar of a phrase.

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.

BarMultiple

Only used with Point: NextBar. Waits for every Nth bar counted from the grid origin, so 4 hands over on four-bar phrase boundaries. Omit, 0 or 1 all mean every bar.

Type information: Integer defaults to: 0

On this page