Home Reference Source

import {SoundInterface} from 'shapez.io/js/platform/sound.js'

public class | source

SoundInterface

Direct Subclass:

SoundImplBrowser

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	app: Application
public	currentMusic: MusicInstanceInterface
public	music: Object<string, MusicInstanceInterface>
public	musicClass: *
public	musicVolume: number
public	pageIsVisible: boolean
public	soundClass: *
public	soundVolume: number
public	sounds: Object<string, SoundInstanceInterface>

Method Summary

Public Methods
public	deinitialize(): Promise<void> Deinits the sound
public	getMusicVolume(): number Returns the music volume
public	getSoundVolume(): number Returns the sound volume
public	initialize(): Promise<any> Initializes the sound
public	loadSound(key: string): Promise<void> Pre-Loads the given sounds
public	onPageRenderableStateChanged(pageIsVisible: boolean) Focus change handler, called by the pap
public	play3DSound(key: string, worldPosition: Vector, root: GameRoot)
public	playThemeMusic(key: string)
public	playUiSound(key: string)
public	setMusicVolume(volume: number) Sets the music volume
public	setSoundVolume(volume: number) Sets the sound volume

Public Constructors

public constructor() source

Public Members

public app: Application source

public currentMusic: MusicInstanceInterface source

public music: Object<string, MusicInstanceInterface> source

public musicClass: * source

public musicVolume: number source

public pageIsVisible: boolean source

public soundClass: * source

public soundVolume: number source

public sounds: Object<string, SoundInstanceInterface> source

Public Methods

public deinitialize(): Promise<void> source

Deinits the sound

Return:

public getMusicVolume(): number source

Returns the music volume

Return:

public getSoundVolume(): number source

Returns the sound volume

Return:

public initialize(): Promise<any> source

Initializes the sound

Return:

public loadSound(key: string): Promise<void> source

Pre-Loads the given sounds

Params:

Name	Type	Attribute	Description
key	string

Return:

public onPageRenderableStateChanged(pageIsVisible: boolean) source

Focus change handler, called by the pap

Params:

Name	Type	Attribute	Description
pageIsVisible	boolean

public play3DSound(key: string, worldPosition: Vector, root: GameRoot) source

Params:

Name	Type	Attribute	Description
key	string
worldPosition	Vector
root	GameRoot

public playThemeMusic(key: string) source

Params:

Name	Type	Attribute	Description
key	string

public playUiSound(key: string) source

Params:

Name	Type	Attribute	Description
key	string

public setMusicVolume(volume: number) source

Sets the music volume

Params:

Name	Type	Attribute	Description
volume	number

public setSoundVolume(volume: number) source

Sets the sound volume

Params:

Name	Type	Attribute	Description
volume	number