Skip to content

Documentation: TrackDef

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

Description

TrackDef is a subclass of SongDef, so you can expect it to support all the same fields that SongDef does.

Fields

Type Field Default Description of Use
string label Used as the track's title when Now Playing is enabled.
Cue cue Cue.None When a track is associated with a Cue, it only plays during specified events that trigger it. This is used for battle tracks, menu and credits, as well as secret songs and the likes. More information in Cues below.
List<BiomeDef> allowedBiomes Restricts this track to only play when the current map is in the allowed Biomes. Similar to SongDef's allowedSeasons feature.
bool vanillaLogic false if true, uses vanilla's AppropriateNow logic to figure out if a track should be played, without this, a track not associated with a Cue will be considered "appropriate"

Example

<MusicExpanded.TrackDef>
  <label>Glitterworld - Aurora Borealis</label>
  <defName>ME_Glitterworld_AuroraBorealis</defName>
  <clipPath>MusicExpanded/Glitterworld/Rim Glitterworld - Aurora Borealis</clipPath>
</MusicExpanded.TrackDef>

HasNamedColonist Example

This TrackDef will play when you start a colony with a colonist named "Odeum"

<MusicExpanded.TrackDef>
  <label>Glitterworld - Odeum's Song</label>
  <defName>ME_Glitterworld_StartWithOdeum</defName>
  <clipPath>MusicExpanded/Glitterworld/Rim Glitterworld - [Secret Song] Start Colony With a Pawn Named Odeum</clipPath>
  <cue>HasColonistNamed</cue>
  <cueData>Odeum</cueData>
</MusicExpanded.TrackDef>