Skip to Content
defold-typescript libraries
thejustinwalsh

thejustinwalsh/defold-zzfx/zzfx

ZzFX extension for Defold

  • GitHub: thejustinwalsh/defold-zzfx — pinned to 8c90e12
    1. Pick a release from thejustinwalsh/defold-zzfx releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as zzfx from "zzfx.api"

Functions

play(args: number[])

Build a sample from a ZzFX parameter list and play it in one call.

Parameters

  • args: number[]

samplerate(rate: number)

Set the sample rate used to render subsequent samples. Defaults to 44100.

Parameters

  • rate: number

play_sample(sample: ZzFXSample)

Play a sample previously returned by {@link build_sample}.

Parameters

  • sample: ZzFXSample

build_sample(args: number[]): ZzFXSample

Build a reusable sample from a ZzFX parameter list, without playing it.

Parameters

  • args: number[]

Returns

  • ZzFXSample

On this page