mwg API
    Preparing search index...

    Interface SfxDefinition

    A sound effect described as data and voiced by a synthesis backend instead of read from a file. mwg owns the shape the game and the mixer need (an id, a priority, what a second trigger does, a caption); whatever else a backend wants (chip, voices, curves) rides along untouched, so a retro-instrument package can carry its own SfxDefinition through unchanged.

    interface SfxDefinition {
        caption?: string;
        id: string;
        priority?: number;
        retrigger?: "ignore" | "layer" | "restart";
        [backendData: string]: unknown;
    }

    Indexable

    • [backendData: string]: unknown
    Index
    caption? id priority? retrigger?
    caption?: string

    shown by a captioning overlay each time the effect plays

    id: string
    priority?: number

    higher cuts lower when the mixer is full; 0 when omitted

    retrigger?: "ignore" | "layer" | "restart"

    what a second trigger does while the first still sounds: 'restart' (the default), 'ignore', or 'layer'

    Settings
    Member Visibility

    On This Page
    Properties