StopSndCommand

Extends: ESCBaseCommand < Node

Description

stop_snd [player]

Stops the given sound player’s stream.

Parameters

  • player: Sound player to use. Either _sound, which is used to play non- looping sound effects; _music, which plays looping music; or _speech, which plays non-looping voice files (default: _music)

@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.