Skip to content

Documentation: ModExtension.PlayCue

Daniel Cavazos edited this page Nov 22, 2022 · 1 revision

Description

This modextension is intended to allow IncidentDefs to trigger tracks with a specific cue and matching cueData, if used.

Fields

Type Field Default Description of Use
bool playBattleTrack false If true, the event this extension is on will dynamically play a battle cue based on points. If your event doesn't use points, it's likely easier to simply use the cue field.
Cue cue Cue.None When set, the event this extension is on will play a track with that Cue set on it, if one exists.
string cueData Used for specific cues. See Cues for more information

Example

This extension will make an incidentDef trigger an appropriate battleTrack, depending on the severity of the incident.

<modExtensions>
    <li Class="MusicExpanded.ModExtension.PlayCue">
        <playBattleTrack>true</playBattleTrack>
    </li>
</modExtensions>