Unturned-Docs

NOTICE: You are not reading the most up-to-date documentation. This file is old, and may not reflect the current modding or server capabilities. The latest documentation can be found at Unturned Documentation.

This file may be removed in the future. Refer to its more up-to-date equivalent instead.

Stereo Song Asset

Defines a music track that can be played on the in-game stereo item. (Or any custom music player item for that matter.) For an example refer to Unturned_Theme.asset in the Songs folder.

This is an Asset v2 class.

Asset Properties Reference

Title string: display text to show in the music player menu. If a localization .dat file is present the Name key will be used, or a translation reference can be used. Examples:

"Title" "My song"

OR

Name in {Language}.dat file

OR

"Title"
{
	"Namespace" "SDG"
	"Token" "Stereo_Songs.Unturned_Theme.Title"
}

Song Master Bundle Pointer: audio clip to play. Can either be a newer master bundle pointer or an older content pointer. Examples:

"Song"
{
	"MasterBundle" "core.masterbundle"
	"AssetPath" "Effects/Ambience/Cave_0/Cave_0.ogg"
}

OR

"Song"
{
	"Name" "core.content"
	"Path" "assets/resources/bundles/songs/unturned_theme.mp3"
}

Link_URL string: optional URL to open in web browser when external link button is clicked.

Is_Loop bool: whether audio source should loop. Recommend NOT using mp3 format for looping music.