ZoneMusic

Zone Music

Zone Music and Zone Ambience Tutorial Video

Zones Links and Zone Music

Zone Music is a Zone Link Item that plays an audio track when an activator triggers the Zone Music's Zone Link. Under most circumstances, the Event Type should be left as Primary. The Zone Music component can handle typical Unity audio types, like .wav, .ogg and mp3 in its Clip Main field. Additionally, with the External BONELAB Content Pallet added in the Asset Warehouse (see Getting Started), all of the music from the game will be available in the form of MonoDisc Datacards, which can be set in the Track field. You can also create custom Monodiscs and add them to your own working pallet by selecting the working Pallet in the Asset Warehouse and choosing Add Mono Disc.

You can quickly create a Zone Music by selecting a Zone Link and opening the Zone Music and Ambience Utils foldout and using the Add buttons. The Connect Orphaned Child button should rarely be needed as it is used to fix a Zone Music or Ambience component that somehow does not have the correct Zone Link field set.

• Clicking Add Zone Music Child will auto-create a Zone Music object as a child to the Zone Link and set some typical defaults.

Usage and Considerations

By default, Zone Music is set to Only Trigger Once and will Play On Enter. You can ensure the music track loops under the Looping Options section. Hovering over any field will provide additional information and suggestions for configuring that field.

If no other Zone Music is triggered and no Zone Music has Stop On Enter/Exit, then the most-recently triggered Zone Music continue to play even if the Activator (usually player) leaves the Zone that started the music.

The Clip Intro field and its MonoDisc equivalent, Intro Track, allow you to play an introductory clip that fires the first time the Zone Music is triggered. After which, the Clip Main or Track will be played. If the Zone Music is set with Loop enabled, the Clip Main/Track portion will repeat.

Best Practice Tip: Set Zone Music items for every Zone

• If the same track is listed in other Zones and Loop is checked, but no Play On Enter/Stop on Enter/Exit boxes are checked, the current music will continue to play without interruption.

• Keep in mind that Trigger Only Once applies to Stop On Enter/Exit options in addition to the Play On Enter option. For example, if music is supposed to start every time the player enters Zone On and stop any time they enter Zone Off, if the Zone On Zone Music has its Trigger Only Once option disabled but the Zone Off Zone Music has its Trigger Only Once enabled, then repeat visits of those Zones will only stop the music one time. If the player enters Zone On any time after the Zone Off has been triggered, the Zone On music may unintentionally play forever.