Interface PlaySoundEvent<Ch>

Event to trigger fire-and-forget sound playback from any system.

interface PlaySoundEvent<Ch extends string = string> {
    channel?: Ch;
    loop?: boolean;
    sound: string;
    volume?: number;
}

Type Parameters

Ch extends string = string

Index

Properties

channel? loop? sound volume?

Properties

`Optional`channel

channel?: Ch

Channel to play on

`Optional`loop

loop?: boolean

Whether sound loops

sound

sound: string

Asset key for the sound

`Optional`volume

volume?: number

Individual volume (0-1)