ESCSoundPlayer

Extends: Control

Description

Background sound player

Property Descriptions

global_id

export var global_id: String = "_sound"

Global id of the background sound player

state

var state: String = "default"

The state of the sound player. “default” or “off” disable sound Any other state refers to a sound 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)

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