infoAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games exploreDiscover Games
categoryWorkshop
sports_esportsGames landscapeMaps view_in_arModels textureMaterials apparelClothing constructionMore..
forumForum menu_bookLearn
docsDocumentation apiApi Reference schoolTutorials manage_searchCode Search
Api
Components
MusicComponent
chevron_left Components
class
MusicComponent

Constructors

functionsMusicComponent

Properties

data_objectFadeIndata_objectFadeOutdata_objectLoopdata_objectPlayOnStartdata_objectStopOnDisabledata_objectTrackdata_objectVolume

Methods

functionsPlayfunctionsStop
MusicComponent
Plays background music through Sandbox.Game.Music. Drop it in, pick a track. Only one track plays at a time, so enabling another music component crossfades to it. Music isn't tied to the scene - to keep a track going across scene loads either put this on a DontDestroyOnLoad object or turn off StopOnDisable.
class Sandbox .account_tree extends Component
sealedSandbox.Engine

build Constructors 1

MusicComponent ()

data_object Properties 7

FadeIn
float
Seconds to fade in when starting, and to crossfade from whatever was playing.
FadeOut
float
Seconds to fade out when stopping.
Loop
bool
Start again when the track ends.
PlayOnStart
bool
Start playing as soon as this component is enabled.
StopOnDisable
bool
Stop the music when this component is disabled or destroyed, if it's still the track playing. Turn off to let it carry on, e.g. across a scene load.
Track
SoundFile
The music to play. Tick Loop in the sound editor for a gapless loop.
Volume
float
Volume of this track, on top of the game's music volume.

functions Methods 2

Play ()
Play this track, crossfading from whatever is playing.
Stop ()
Fade out and stop, if this track is the one playing.

Inheritance

Component
MusicComponent
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.