Script MusicComponents
Components
musicLayerAddVolume | Increases the volume of a music layer while the listener is near the entity |
musicLayerCheckOpenRoom | Reduces the volume added by musicLayerAddVolume if the entity is in a separate, closed-off room |
musicLayerDeactivateOnProvoke | Upon provocation, disables any active music layer modifiers |
musicLayerFlyaway | |
musicLayerVocalOverride | Overrides the song's vocal track type if the entity exists at the start of the level |
upgradeByVocalSettings | Converts the entity based on the local player's vocal settings |
Components
- musicLayerAddVolume
-
Increases the volume of a music layer while the listener is near the entity
- active bool (default true)
- effective bool (default false)
- layerTag constant int (default 0)
- innerRadius constant float (default 0)
- outerRadius constant float (default 1)
- innerVolume constant float (default 1)
- outerVolume constant float (default 1)
- musicLayerCheckOpenRoom
-
Reduces the volume added by musicLayerAddVolume if the entity is in a separate, closed-off room
- volume constant float (default 1)
- musicLayerDeactivateOnProvoke
- Upon provocation, disables any active music layer modifiers
- musicLayerFlyaway
-
- text constant string (default ui.Symbol.EIGHTH_NOTES)
- musicLayerVocalOverride
-
Overrides the song's vocal track type if the entity exists at the start of the level
- vocals constant string (default "")
- upgradeByVocalSettings
-
Converts the entity based on the local player's vocal settings default:
{}
- upgrades constant table