Files
gymkhana-actions/docs/api/ESCSoundPlayer.md
Dennis Ploeger c8958e7454 Issue 377 (#383)
* feat: Implements speech fixes #377

* docs: Automatic update of API docs

* chore: Updated speech translation.

Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-09-06 08:52:16 +02:00

868 B

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