Files
gymkhana-actions/docs/api/SetSoundStateCommand.md
Dennis Ploeger 58d880101d Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
2021-06-22 23:06:20 +02:00

884 B

SetSoundStateCommand

Extends: ESCBaseCommand < Node

Description

set_sound_state player sound loop

Change the sound playing on player to sound with optional looping if loop is true. Valid players are "bg_music" and "bg_sound". Aside from paths to sound or music files, the values off and default. default is the default value. are also valid for sound

@ESC

Method Descriptions

configure

func configure() -> ESCCommandArgumentDescriptor

Return the descriptor of the arguments of this command

validate

func validate(arguments: Array)

Validate wether the given arguments match the command descriptor

run

func run(command_params: Array) -> int

Run the command