PlayMusic
PlayMusic is a built-in component for playing background music in your scene. This component can be found in the built-in components section of the Assets Catalog and attached to any GameObject. Use it to play music from AudioShader assets or from URLs.
Methods
Plays the specified music AudioShader asset.
--!SerializedField
local MusicObject : GameObject = nil
local musicPlayer = MusicObject:GetComponent(PlayMusic)
musicPlayer.Play(musicAsset)
Parameters
music
Returns
void
Plays music from a URL. Useful for streaming audio or loading external music files.
--!SerializedField
local MusicObject : GameObject = nil
local musicPlayer = MusicObject:GetComponent(PlayMusic)
musicPlayer.PlayFromURL("https://example.com/music.mp3")
Parameters
url
string
Returns
void
Stops the currently playing music. Optionally fades out the music before stopping.
--!SerializedField
local MusicObject : GameObject = nil
local musicPlayer = MusicObject:GetComponent(PlayMusic)
musicPlayer.StopMusic(true) -- fade out
musicPlayer.StopMusic(false) -- stop immediately
Parameters
fadeOut
boolean
Returns
void
Updated 13 days ago
