@drincs/pixi-vn 1.6.4 → 1.8.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { IMediaInstance as IMediaInstance$1, PlayOptions, Options, SoundLibrary, Sound } from '@pixi/sound';
+import { PlayerOptions, Player, ToneAudioNode, Param, ReverbOptions, FeedbackDelayOptions, FreeverbOptions, DelayOptions, PingPongDelayOptions, GateOptions, AutoFilterOptions, BiquadFilterOptions, OnePoleFilterOptions, FeedbackCombFilterOptions, FilterOptions, ChorusOptions, PhaserOptions, TremoloOptions, VibratoOptions, CompressorOptions, MidSideCompressorOptions, MultibandCompressorOptions, LimiterOptions, GreaterThanOptions, GreaterThanZeroOptions, DistortionOptions, BitCrusherOptions, Panner3DOptions, AutoPannerOptions, StereoWidenerOptions } from 'tone';
 import * as canvasUtils from '@drincs/pixi-vn/canvas';
 import { StoredChoiceInterface, StorageElementType as StorageElementType$1, OpenedLabel as OpenedLabel$1 } from '@drincs/pixi-vn/canvas';
 export * from '@drincs/pixi-vn/canvas';
@@ -22,29 +22,94 @@ import { CharacterInterface, GameStepState } from '@drincs/pixi-vn';
 import { Difference } from 'microdiff';
 import { Devtools } from '@pixi/devtools';
 
-type IMediaInstance = Omit<IMediaInstance$1, "on" | "destroy" | "init" | "off" | "once" | "toString">;
+interface MediaInterface extends Pick<Player, "blockTime" | "disposed" | "loaded" | "loop" | "loopEnd" | "loopStart" | "mute" | "now" | "playbackRate" | "reverse" | "restart" | "start" | "stop" | "chain" | "disconnect" | "volume" | "state"> {
+    /**
+     * Whether the sound is currently paused.
+     */
+    paused: boolean;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted: boolean;
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed: number;
+}
+interface MediaMemory extends Partial<Omit<PlayerOptions, "url" | "volume">> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume. Stored and restored in linear form; converted
+     * to/from Tone.js decibels internally.
+     */
+    volume?: number;
+    elapsed: number | undefined;
+    paused: boolean;
+    delay?: number;
+}
 
-interface SoundOptions extends Omit<Options, "complete" | "loaded" | "sprites" | "source"> {
+interface SoundOptions extends Pick<Partial<PlayerOptions>, "loop" | "autostart" | "fadeIn" | "fadeOut" | "mute" | "loopEnd" | "loopStart" | "reverse" | "playbackRate"> {
+    /**
+     * The volume of this sound in the linear range [0, 1], where 0 is silence
+     * and 1 is full volume.  This is converted to decibels internally before
+     * being passed to the Tone.js Player.
+     */
+    volume?: number;
+    /**
+     * A collection of audio filters/effects to apply to this sound.
+     *
+     * Install "tone" for the full list of available filters.
+     *
+     * @example
+     * ```ts
+     * import * as Tone from "tone";
+     *
+     * const filters = [new Tone.FeedbackDelay("8n", 0.5)];
+     * ```
+     */
+    filters?: ToneAudioNode[];
+    /**
+     * @deprecated Use {@link playbackRate} instead.
+     */
+    speed?: number;
+    /**
+     * @deprecated Use {@link mute} instead.
+     */
+    muted?: boolean;
 }
-interface SoundPlayOptions extends Omit<PlayOptions, "complete" | "loaded"> {
+interface SoundPlayOptions extends SoundOptions {
     /**
-     * The delay in seconds before playback becomes audible or resumes. If specified, the sound will be started immediately but delayed (for example, via pause/unpause) so that it is effectively heard only after the delay. If not specified, the sound will play without any additional delay.
+     * The delay in seconds before playback starts. If specified, playback is
+     * scheduled to begin after the delay has elapsed rather than starting
+     * immediately in a paused state.
      */
     delay?: number;
+    /**
+     * The offset in seconds from the start of the sound at which to begin playback.
+     */
+    elapsed?: number;
 }
 interface SoundPlayOptionsWithChannel extends SoundPlayOptions {
     /**
-     * The alias of the audio channel to play the sound on. If the channel does not exist, it will be created.
-     * If not specified, the sound will be played on the default channel (see `SoundManagerInterface.defaultChannelAlias`).
+     * The alias of the audio channel to play the sound on. If the channel does
+     * not exist it will be created automatically.
+     * Defaults to `SoundManagerInterface.defaultChannelAlias` ("general").
      */
     channel?: string;
 }
 interface ChannelOptions extends Pick<SoundPlayOptions, "filters" | "muted" | "volume"> {
     /**
      * Whether this channel is a background channel.
-     * Background channels are special channels. Unlike normal channels, media connected to a background channel does not stop when a scene changes, but continues to play in the background.
+     * Background channels are special: media playing on them is not stopped
+     * when a scene changes, but continues in the background.
      */
     background?: boolean;
+    /**
+     * The stereo pan position for this channel in the range [-1, 1].
+     * -1 is full left, 0 is centre, 1 is full right.
+     * Defaults to 0.
+     */
+    pan?: number;
 }
 
 interface AudioChannelInterface {
@@ -60,7 +125,7 @@ interface AudioChannelInterface {
      *        this cannot be reused after it is done playing. Returns a Promise if the sound
      *        has not yet loaded.
      */
-    play(alias: string, options?: SoundPlayOptions): Promise<IMediaInstance>;
+    play(alias: string, options?: SoundPlayOptions): Promise<MediaInterface>;
     /**
      * Plays a sound.
      * @param mediaAlias The media alias reference.
@@ -70,7 +135,12 @@ interface AudioChannelInterface {
      *        this cannot be reused after it is done playing. Returns a Promise if the sound
      *        has not yet loaded.
      */
-    play(mediaAlias: string, soundAlias: string, options?: SoundPlayOptions): Promise<IMediaInstance>;
+    play(mediaAlias: string, soundAlias: string, options?: SoundPlayOptions): Promise<MediaInterface>;
+    /**
+     * The stereo pan position for this channel in the range [-1, 1].
+     * -1 is full left, 0 is centre, 1 is full right.
+     */
+    pan: number;
     /**
      * The volume of the audio channel, between 0 and 1. This is multiplied with the volume of each sound played through this channel.
      */
@@ -82,7 +152,7 @@ interface AudioChannelInterface {
     /**
      * The MediaInstances currently playing through this channel. This is read-only and cannot be modified directly. Use the play method to add new MediaInstances to this channel.
      */
-    readonly mediaInstances: IMediaInstance[];
+    readonly mediaInstances: MediaInterface[];
     /**
      * Whether this channel is a background channel.
      * Background channels are special channels. Unlike normal channels, media connected to a background channel does not stop when a scene changes, but continues to play in the background.
@@ -108,45 +178,128 @@ interface AudioChannelInterface {
      * @return `true` if all sounds are muted.
      */
     toggleMuteAll(): boolean;
+    /**
+     * Useful for inserting channel-wide audio effects such as reverb, delay or EQ.
+     *
+     * Install "tone" to use this method.
+     *
+     * @param nodes One or more Tone.js {@link ToneAudioNode} instances to chain in series.
+     * @return Instance for chaining.
+     *
+     * @example
+     * ```ts
+     * import * as Tone from "tone";
+     *
+     * const channel = sound.findChannel("music");
+     *
+     * // Create a reverb effect and wait for its impulse response to be ready.
+     * const reverb = new Tone.Reverb({ decay: 2.5 });
+     *
+     * // Route the channel through the reverb to the master output.
+     * channel.chain(reverb);
+     * ```
+     */
+    chain(...nodes: ToneAudioNode[]): this;
+    /**
+     * **Advanced** — the raw `Tone.Param<"decibels">` for this channel's volume.
+     *
+     * Unlike the {@link volume} property (which uses a linear 0–1 scale), this
+     * Param works directly in **decibels** and exposes all Tone.js automation
+     * methods such as `rampTo`, `linearRampTo`, and `exponentialRampTo`.
+     *
+     * Use this when you need to smoothly automate volume over time instead of
+     * setting it instantly.
+     *
+     * @example
+     * ```ts
+     * const channel = sound.findChannel("music");
+     *
+     * // Fade the volume from its current level to -12 dB over 3 seconds.
+     * channel.volumeParam.rampTo(-12, 3);
+     *
+     * // Fade to silence over 2 seconds.
+     * channel.volumeParam.rampTo(-Infinity, 2);
+     * ```
+     */
+    readonly volumeParam: Param<"decibels">;
+    /**
+     * **Advanced** — the raw `Tone.Param<"audioRange">` for this channel's
+     * stereo pan position.
+     *
+     * Unlike the {@link pan} property (which sets the value instantly), this
+     * Param exposes all Tone.js automation methods such as `rampTo`,
+     * `linearRampTo`, and `exponentialRampTo`.
+     *
+     * Use this when you need to smoothly automate panning over time instead of
+     * setting it instantly.  Values range from -1 (full left) to 1 (full right).
+     *
+     * @example
+     * ```ts
+     * const channel = sound.findChannel("music");
+     *
+     * // Gradually pan to the left over 3 seconds.
+     * channel.panParam.rampTo(-1, 3);
+     *
+     * // Return to centre over 2 seconds.
+     * channel.panParam.rampTo(0, 2);
+     * ```
+     */
+    readonly panParam: Param<"audioRange">;
 }
 
-type DistortionFilter = {
-    type: "DistortionFilter";
-    amount?: number;
-};
-type EqualizerFilter = {
-    type: "EqualizerFilter";
-    f32?: number;
-    f64?: number;
-    f125?: number;
-    f250?: number;
-    f500?: number;
-    f1k?: number;
-    f2k?: number;
-    f4k?: number;
-    f8k?: number;
-    f16k?: number;
-};
-type MonoFilter = {
-    type: "MonoFilter";
-};
-type ReverbFilter = {
-    type: "ReverbFilter";
-    seconds?: number;
-    decay?: number;
-    reverse?: boolean;
-};
-type StereoFilter = {
-    type: "StereoFilter";
-    pan?: number;
-};
-type StreamFilter = {
-    type: "StreamFilter";
-};
-type TelephoneFilter = {
-    type: "TelephoneFilter";
-};
-type SoundFilterMemory = DistortionFilter | EqualizerFilter | MonoFilter | ReverbFilter | StereoFilter | StreamFilter | TelephoneFilter;
+type SoundFilterMemory = ({
+    filterType: "ReverbFilter";
+} & Omit<Partial<ReverbOptions>, "context">) | ({
+    filterType: "FeedbackDelayFilter";
+} & Omit<Partial<FeedbackDelayOptions>, "context">) | ({
+    filterType: "FreeverbFilter";
+} & Omit<Partial<FreeverbOptions>, "context">) | ({
+    filterType: "DelayFilter";
+} & Omit<Partial<DelayOptions>, "context">) | ({
+    filterType: "PingPongDelayFilter";
+} & Omit<Partial<PingPongDelayOptions>, "context">) | ({
+    filterType: "GateFilter";
+} & Omit<Partial<GateOptions>, "context">) | ({
+    filterType: "AutoFilterFilter";
+} & Omit<Partial<AutoFilterOptions>, "context">) | ({
+    filterType: "BiquadFilterFilter";
+} & Omit<Partial<BiquadFilterOptions>, "context">) | ({
+    filterType: "OnePoleFilterFilter";
+} & Omit<Partial<OnePoleFilterOptions>, "context" | "frequency">) | ({
+    filterType: "FeedbackCombFilterFilter";
+} & Omit<Partial<FeedbackCombFilterOptions>, "context">) | ({
+    filterType: "CustomFilter";
+} & Omit<Partial<FilterOptions>, "context">) | ({
+    filterType: "ChorusFilter";
+} & Omit<Partial<ChorusOptions>, "context">) | ({
+    filterType: "PhaserFilter";
+} & Omit<Partial<PhaserOptions>, "context">) | ({
+    filterType: "TremoloFilter";
+} & Omit<Partial<TremoloOptions>, "context">) | ({
+    filterType: "VibratoFilter";
+} & Omit<Partial<VibratoOptions>, "context">) | ({
+    filterType: "CompressorFilter";
+} & Omit<Partial<CompressorOptions>, "context">) | ({
+    filterType: "MidSideCompressorFilter";
+} & Omit<Partial<MidSideCompressorOptions>, "context">) | ({
+    filterType: "MultibandCompressorFilter";
+} & Omit<Partial<MultibandCompressorOptions>, "context">) | ({
+    filterType: "LimiterFilter";
+} & Omit<Partial<LimiterOptions>, "context">) | ({
+    filterType: "GreaterThanFilter";
+} & Omit<Partial<GreaterThanOptions>, "context">) | ({
+    filterType: "GreaterThanZeroFilter";
+} & Omit<Partial<GreaterThanZeroOptions>, "context">) | ({
+    filterType: "DistortionFilter";
+} & Omit<Partial<DistortionOptions>, "context">) | ({
+    filterType: "BitCrusherFilter";
+} & Omit<Partial<BitCrusherOptions>, "context">) | ({
+    filterType: "Panner3DFilter";
+} & Omit<Partial<Panner3DOptions>, "context">) | ({
+    filterType: "AutoPannerFilter";
+} & Omit<Partial<AutoPannerOptions>, "context">) | ({
+    filterType: "StereoWidenerFilter";
+} & Omit<Partial<StereoWidenerOptions>, "context">);
 
 interface ExportedSound {
     options: SoundOptions;
@@ -164,7 +317,6 @@ interface ExportedSoundPlay extends SoundPlay {
  * Interface exported sounds
  */
 interface SoundGameState {
-    filters?: SoundFilterMemory[];
     /**
      * @deprecated
      */
@@ -176,108 +328,130 @@ interface SoundGameState {
             channelAlias: string;
             soundAlias: string;
             stepCounter: number;
-            options: Omit<SoundPlayOptions, "filters"> & {
+            options: MediaMemory & {
                 filters?: SoundFilterMemory[];
+                delay?: number;
             };
-            paused: boolean;
+            /**
+             * @deprecated Use options.paused instead.
+             */
+            paused?: boolean;
         };
     };
 }
 
-interface SoundManagerInterface extends Omit<SoundLibrary, "init" | "close" | "add" | "play" | "volume" | "speed" | "remove" | "exists" | "find" | "stop" | "pause" | "resume" | "pauseAll" | "resumeAll" | "muteAll" | "unmuteAll" | "stopAll" | "removeAll" | "togglePauseAll"> {
+interface SoundManagerInterface {
+    /** Master volume in the range [0, 1]. */
+    volumeAll: number;
+    /**
+     * @deprecated Global playback speed. This is not a well-supported feature and may be removed in a future release. Use individual sound speed options instead.
+     */
+    speedAll: number;
+    /**
+     * The default channel alias used when playing a sound without specifying a
+     * channel. Defaults to `"general"`.
+     */
+    defaultChannelAlias: string;
     /**
-     * @deprecated You can define sound assets directly in `PIXI.Assets`
+     * @deprecated Register sound assets directly via `PIXI.Assets` instead.
      */
-    add(alias: string, options: string): Sound;
+    add(alias: string, options: string): void;
     /**
      * Plays a sound.
      * @param alias The media and sound (asset) alias reference.
-     * @param options The options
-     * @return The sound instance,
-     *        this cannot be reused after it is done playing. Returns a Promise if the sound
-     *        has not yet loaded.
+     * @param options The options.
+     * @returns The media instance (resolves immediately if already loaded).
      */
-    play(alias: string, options?: SoundPlayOptionsWithChannel): Promise<IMediaInstance>;
-    play(mediaAlias: string, soundAlias: string, options?: SoundPlayOptionsWithChannel): Promise<IMediaInstance>;
+    play(alias: string, options?: SoundPlayOptionsWithChannel): Promise<MediaInterface>;
+    play(mediaAlias: string, soundAlias: string, options?: SoundPlayOptionsWithChannel): Promise<MediaInterface>;
     /**
-     * Find a media by alias.
-     * @param alias - The media alias reference.
-     * @return Media object.
+     * Plays a non-persistent ("transient") sound (e.g. UI / menu sounds).
+     * Transient playback is not tracked in save/export state.
      */
-    find(alias: string): IMediaInstance | undefined;
+    playTransient(alias: string, options?: Partial<PlayerOptions>): Promise<Player>;
     /**
-     * Stops a media and removes it from the manager.
-     * @param alias - The media alias reference.
+     * Find a tracked media instance by alias.
      */
-    stop(alias: string): void;
+    find(alias: string): MediaInterface | undefined;
     /**
-     * Pauses a media.
-     * @param alias - The media alias reference.
-     * @return Media object.
+     * Stop a tracked media instance and remove it from the manager.
      */
-    pause(alias: string): IMediaInstance | undefined;
+    stop(alias: string): void;
     /**
-     * Resumes a media.
-     * @param alias - The media alias reference.
-     * @return Media object.
+     * Pause a tracked media instance.
      */
-    resume(alias: string): IMediaInstance | undefined;
+    pause(alias: string): MediaInterface | undefined;
     /**
-     * Edits the options of an existing sound (asset).
-     * If the asset is not yet loaded, it will be loaded with the new options.
+     * Resume a paused media instance.
      */
-    edit(alias: string, options: SoundOptions): Promise<void>;
+    resume(alias: string): MediaInterface | undefined;
+    /** Duration in seconds of the loaded sound with the given alias. */
+    duration(alias: string): number;
+    /** Toggle mute on all sounds. Returns the new muted state. */
+    toggleMuteAll(): boolean;
     /**
-     * Pauses any playing sounds.
-     * @return Instance for chaining.
+     * Whether all sounds are currently muted. Note that individual channels or media instances may still be muted or unmuted; this is just the global master mute state.
      */
+    readonly muted: boolean;
+    /** Mute all sounds. */
+    muteAll(): this;
+    /** Unmute all sounds. */
+    unmuteAll(): this;
+    /** Stop all sounds. */
+    stopAll(): this;
+    /** Pause all sounds. */
     pauseAll(): this;
-    /**
-     * Resumes any sounds.
-     * @return Instance for chaining.
-     */
+    /** Resume all sounds. */
     resumeAll(): this;
     /**
-     * Mutes all playing sounds.
-     * @return Instance for chaining.
+     * Temporarily pause all currently-playing sounds (or just those in the given
+     * channel) without persisting the paused state. Useful for overlays / pause
+     * menus.
+     *
+     * Only sounds that are **actively playing** at the time of the call are paused;
+     * sounds that were already paused beforehand are left untouched so that they
+     * remain paused when {@link resumeUnsavedAll} is called later.
+     *
+     * When called without a channel argument all transient players started with
+     * {@link playTransient} are also stopped.
      */
-    muteAll(): this;
+    pauseUnsavedAll(channel?: string): this;
     /**
-     * Unmutes all playing sounds.
-     * @return Instance for chaining.
+     * Resume all sounds (or just those in the given channel) that were paused by
+     * the most recent call to {@link pauseUnsavedAll}. Sounds that were already
+     * paused before `pauseUnsavedAll` was called are **not** resumed.
      */
-    unmuteAll(): this;
+    resumeUnsavedAll(channel?: string): this;
     /**
-     * Stops all sounds.
-     * @return Instance for chaining.
+     * Stop all transient media instances started with {@link playTransient}.
      */
-    stopAll(): this;
-    load(alias: string | string[]): Promise<Sound[]>;
-    backgroundLoad(alias: string | string[]): Promise<void>;
+    stopTransientAll(): this;
+    /** Load one or more sound assets. */
+    load(...alias: string[]): Promise<void>;
+    /** Trigger background loading of one or more sound assets. */
+    backgroundLoad(...alias: string[]): Promise<void>;
+    /** Trigger background loading of a sound bundle. */
     backgroundLoadBundle(alias: string): Promise<void>;
+    /** Stop all sounds and clear internal state. */
     clear(): void;
     /**
-     * Adds a new audio channel with the specified alias(es).
-     * @param alias The alias or aliases for the new channel.
-     * @returns The created AudioChannelInterface instance, or undefined if a channel with the alias already exists.
+     * Add a new audio channel.
+     * Returns the created channel, or `undefined` if the alias already exists.
      */
     addChannel(alias: string | string[], options?: ChannelOptions): AudioChannelInterface | undefined;
     /**
-     * Finds and returns the audio channel associated with the given alias. If the channel does not exist, it will be created.
-     * @param alias The alias of the audio channel to find.
-     * @returns The AudioChannelInterface instance associated with the alias.
+     * Find the channel for the given alias, creating it if it does not yet exist.
      */
     findChannel(alias: string): AudioChannelInterface;
-    /**
-     * Returns an array of all existing audio channels.
-     */
+    /** All registered audio channels. */
     readonly channels: AudioChannelInterface[];
     /**
-     * The default channel alias to use when playing a sound without specifying a channel.
-     * By default, this is set to `GENERAL_CHANNEL` ("general"), but it can be changed to any string; if the channel does not yet exist, it will be created on demand when used.
+     * Export the current sound state, including currently playing sounds and their options, for saving or debugging purposes. This is not guaranteed to be stable across versions and may contain implementation details; it is not intended for use in general application code.
      */
-    defaultChannelAlias: string;
     export(): SoundGameState;
+    /**
+     * Restore a sound state exported by {@link export}. This will stop any currently playing sounds and replace them with the sounds specified in the exported state. This is not guaranteed to be stable across versions and may contain implementation details; it is not intended for use in general application code.
+     */
     restore(data: object): Promise<void>;
 }
 
@@ -535,7 +709,7 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-var version = "1.6.4";
+var version = "1.8.0";
 
 /**
  * @deprecated
@@ -552,10 +726,6 @@ declare function Pause(duration: number): PauseType;
  * Is a special alias to indicate the game layer.
  */
 declare const CANVAS_APP_GAME_LAYER_ALIAS = "__game_layer__";
-/**
- * The default audio channel for sounds that don't specify one.
- */
-declare const GENERAL_CHANNEL = "general";
 declare const SYSTEM_RESERVED_STORAGE_KEYS: {
     /**
      * The key of the current dialogue memory
@@ -850,7 +1020,12 @@ declare namespace Game {
     /**
      * Load the save data
      * @param data The save data
-     * @param navigate The function to navigate to a path
+     */
+    function restoreGameState(data: GameState): Promise<void>;
+    /**
+     * @deprecated Use `restoreGameState(data)` (without the `navigate` argument) and configure navigation via `Game.init({ navigate })` or `Game.onNavigate(...)`.
+     * @param data The save data
+     * @param navigate Navigation function to use for this restore call.
      */
     function restoreGameState(data: GameState, navigate: (path: string) => void | Promise<void>): Promise<void>;
     /**
@@ -979,4 +1154,4 @@ declare const _default: {
     PIXIVN_VERSION: string;
 };
 
-export { CANVAS_APP_GAME_LAYER_ALIAS, CachedMap, GENERAL_CHANNEL, Game, type GameState, type GameStepStateData, version as PIXIVN_VERSION, Pause, Repeat, SYSTEM_RESERVED_STORAGE_KEYS, createExportableElement, _default as default };
+export { CANVAS_APP_GAME_LAYER_ALIAS, CachedMap, Game, type GameState, type GameStepStateData, version as PIXIVN_VERSION, Pause, Repeat, SYSTEM_RESERVED_STORAGE_KEYS, createExportableElement, _default as default };