882 B
882 B
ESCBackgroundMusic
Extends: Control
Description
Background music player
Property Descriptions
global_id
export var global_id: String = "bg_music"
Global id of the background music player
state
var state: String = "default"
The state of the music player. "default" or "off" disable music Any other state refers to a music stream that should be played
stream
var stream: AudioStreamPlayer
Reference to the audio player
Method Descriptions
set_state
func set_state(p_state: String, p_force: bool = false) -> void
Set the state of this player
Parameters
- p_state: New state to use
- p_force: Override the existing state even if the stream is still playing