MusicTransitionInstructions contain the data that define how a MusicLayout horizontally transitions between MusicSegments. They are mainly constructed as part of a MusicLayout's "Class Defaults" and should only reference sound assets that will be used within MusicSegments that the layout uses.
NOTE: The word "music" in this context refers to the sound asset reference held by a MusicSegment.
This bool overrides the "outgoingMusic" property and allows this transition to be chosen for any current music.
A reference to the music that needs to match the current music for this transition to be used. Does nothing if "outgoingAny" is true.
NOTE: Null is valid as a transition out of silence.
This bool overrides the "incomingMusic" property and allows this transition to be chosen for any music queued to transition to next.
A reference to the music that needs to match the music being queued for the next transition in order to be used. Does nothing if "incomingAny" is true.
NOTE: Null is valid as a transition to silence.
Defines what timing the transition should be synchronized with.
Compensates for timing of the transition if the incoming music needs to synchronize with entree time. When cueTime = 0, the transition is timed so the beginning of the incoming music plays exactly on the transition. Add cueTime modifies the transition so it synchronizes the cueTime exactly on the transition (ie. If cueTime = 1 second, the incoming music will play 1 second early to synchronize the incoming music's 1 second mark with the transition).
Defines when a transition will happen based on measure groupings starting from the start of the music (ie. If measureDivision = 4, the transition can happen on beat 1 of measures 5, 9, 13, etc).
If cueType = OnExactBeat, this defines the beat counted from the start of the music to transition on. If cueType = OnExactBeatAndMeasure or OnMeasureBeat, this defines the beat within the current music time signature to transition on.
Defines the measure counted continuously from the start of the music to transition on.
Defines what should happen to the outgoing music when the transition occurs.
If outgoingStopBehavior = FadeOut, this is the amount of time over which the outgoing music will fade out.
If outgoingStopBehavior = FadeOut and fadeOutTime != 0, this curve will be used as the shape of the fade out.
This is the amount of time over which the incoming music will fade in. Does not effect transition timing.
If fadeInTime != 0, this curve will be used as the shape of the fade in.