StopSndCommand
Extends: ESCBaseCommand < Resource
Description
stop_snd [audio_bus]
Stops the given audio bus’s stream.
By default there are 3 audio buses set up by Escoria : _sound
, which is
used to play non-looping sound effects; _music
, which plays looping music;
and _speech
, which plays non-looping voice files (default: _music
).
Each simultaneous sound (e.g. multiple game sound effects) will require its own bus. To create additional buses, see the Godot sound documentation : Audio buses
Parameters
audio_bus: Bus to stop (“_sound”, “_music”, “_speech”, or a custom audio bus you have created.)
@ESC
Property Descriptions
previous_snd_state
var previous_snd_state: String
The previous sound state, saved for interrupting
Method Descriptions
configure
func configure() -> ESCCommandArgumentDescriptor
Return the descriptor of the arguments of this command
validate
func validate(arguments: Array)
Validate whether the given arguments match the command descriptor
run
func run(command_params: Array) -> int
Run the command
interrupt
func interrupt()
Function called when the command is interrupted.