Module Soundtrack
local Soundtrack = require "necro.game.data.Soundtrack"
Classes
Soundtrack.Song
| Type |
Field |
Description |
| Soundtrack.TrackType |
type |
The type of track to play on this level |
| integer? |
zone |
Zone of the track to play on this level (should be between 1 and 4, or 5 for AMPLIFIED) |
| integer? |
floor |
Floor number of the track to play on this level (should be between 1 and 3) |
| Boss.Type? |
boss |
Boss music to play on this level |
Enumerations
Soundtrack.Variant
| Key |
Value |
Description |
Soundtrack.Variant.DEFAULT |
"" |
|
Soundtrack.Variant.HOT |
"h" |
|
Soundtrack.Variant.COLD |
"c" |
|
Soundtrack.Variant.ALTERNATIVE |
"a" |
|
Soundtrack.Variant.ALTERNATIVE_2 |
"b" |
|
Soundtrack.Artist
| Key |
Value |
Description |
Soundtrack.Artist.GIRLFRIEND_RECORDS |
5 |
|
Soundtrack.Artist.DANNY_B |
1 |
|
Soundtrack.Artist.LEGACY_CHIPZEL |
10 |
|
Soundtrack.Artist.RANDOM |
11 |
|
Soundtrack.Artist.CUSTOM |
12 |
|
Soundtrack.Artist.HATSUNE_MIKU |
13 |
|
Soundtrack.Artist.SHOVEL_KNIGHT |
14 |
|
Soundtrack.Artist.A_RIVAL |
2 |
|
Soundtrack.Artist.FAMILYJULES7X |
3 |
|
Soundtrack.Artist.VIRT |
4 |
|
Soundtrack.Artist.OC_REMIX |
6 |
|
Soundtrack.Artist.CHIPZEL |
7 |
|
Soundtrack.Artist.DANGANRONPA |
8 |
|
Soundtrack.Artist.GROOVE_COASTER |
9 |
|
Soundtrack.Vocals
| Key |
Value |
Description |
Soundtrack.Vocals.NONE |
"" |
|
Soundtrack.Vocals.SHOPKEEPER |
"shopkeeper" |
|
Soundtrack.Vocals.MONSTROUS_SHOPKEEPER |
"shopkeeper_m" |
|
Soundtrack.Vocals.NICOLAS_DAOUST |
"shopkeeper_nd" |
|
Soundtrack.TrackType
| Key |
Value |
Description |
Soundtrack.TrackType.ZONE |
"zone" |
|
Soundtrack.TrackType.BOSS |
"boss" |
|
Soundtrack.TrackType.LOBBY |
"lobby" |
|
Soundtrack.TrackType.TRAINING |
"training" |
|
Soundtrack.TrackType.TUTORIAL |
"tutorial" |
|
Soundtrack.TrackType.CREDITS |
"credits" |
|
Soundtrack.TrackType.MAIN_MENU |
"main_menu" |
|
Soundtrack.LayerType
| Key |
Value |
Description |
Soundtrack.LayerType.NONE |
0 |
|
Soundtrack.LayerType.MAIN |
1 |
|
Soundtrack.LayerType.SHOPKEEPER |
2 |
|
Soundtrack.LayerType.HOT |
4 |
|
Soundtrack.LayerType.COLD |
8 |
|
Soundtrack.LayerType.TENTACLE_DRUMS |
16 |
|
Soundtrack.LayerType.TENTACLE_HORNS |
32 |
|
Soundtrack.LayerType.TENTACLE_STRINGS |
64 |
|
Soundtrack.LayerType.TENTACLE_KEYTAR |
128 |
|
Soundtrack.LayerType.FORTISSIMOLE |
256 |
|
Soundtrack.LayerType.PHASE_2 |
512 |
|
Functions
Soundtrack.getDefaultArtists()
Soundtrack.registerDefaultArtist(characterName, artist)
Registers a preferred artist for a specific player character
Parameters
| Type |
Name |
Description |
| Entity.Type |
characterName |
Entity type name of the playable character to register |
| Soundtrack.Artist |
artist |
Artist to set as the preferred/default soundtrack |
Soundtrack.getActiveArtist()
Soundtrack.setCharacterArtist(character, artist)
Soundtrack.getCharacterArtist(character)
Soundtrack.setDefaultArtist(artist)
Soundtrack.getDefaultArtist()
Soundtrack.isArtistAvailable(artist)
Soundtrack.setVocalist(vocal)
Soundtrack.getVocalist()
Soundtrack.isVocalistAvailable(vocal)
Soundtrack.setCustomMusicEnabled(enabled)
Soundtrack.isCustomMusicEnabled()
Soundtrack.getTrack(params)