← Documentation Home

SetBgmVolume

Category: Audio

Back to System Functions

Signature

SetBgmVolume(volume As Float)

Returns

Void

Description

Sets the global background music volume using a 0.0 to 1.0 range.

The runtime applies a non-linear volume curve so values such as 0.5 sound closer to half loudness instead of half linear amplitude.

If background music is already playing, the new volume is applied immediately. Values outside the 0.0 to 1.0 range are clamped.

Example

SetBgmVolume(0.5) PlayBGM("music/title.mp3")