Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 1.17 KB

about_channel_setting.md

File metadata and controls

22 lines (18 loc) · 1.17 KB

How to set Channel Settings

At the root of your soundpack directory, create an xml file. While the name can be arbitrary, channelSettings.xml is recommended.

This file should contain one channelSettings, which contain multiple channelSetting.

Attribute Possible Values Description
name channel_name (required) Channel's name.
Setting for any channels that are not in the soundpack will be ignored.
playType "all"(default), "singleEager", "singleLazy" How the channel will play sounds.
"all": will play all sounds.
"singleEager": will play one sound at a time, and will pause/stop the current playing sounds when a new sound is triggered.
"singleLazy": will play one sound at a time, and will ignore new sounds when already playing a sound.

Example:

<?xml version="1.1" encoding="UTF-8"?>
<channelSettings>
	<channelSetting name="music" playType="singleEager"/>
	<channelSetting name="weather" playType="singleEager"/>
	<channelSetting name="trade" playType="singleLazy"/>
</channelSettings>

Attributes may be added/changed in the future.