bard-legends-framework 1.7.0 → 1.7.2

package/dist/index.d.mts

@@ -144,6 +144,7 @@ declare abstract class View extends IDAttachable {
 }
 
 type AudioAppearTransitionType = 'ease' | 'instant';
+declare const SOUND_TRANSITION_DURATION = 800;
 declare class Audio {
     private constructor();
     setVolumes(volumes: {
@@ -216,7 +217,7 @@ declare class Camera {
     constructor();
     setPosition(position: Vector): void;
     setTransition(options: FocusingOptions): void;
-    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
+    appear(on: boolean, type?: CameraAppearTransitionType, delay?: number): IdleSingleEvent;
     screenPositonToStagePosition(screenPosition: Vector): Vector;
 }
 
@@ -266,17 +267,10 @@ type SoundID = DynamicID<SoundIDRegistry, 'SoundID'>;
 interface SoundDefinition {
     readonly id: SoundID;
     readonly duration: number;
-}
-interface MusicIDRegistry {
-}
-type MusicID = DynamicID<MusicIDRegistry, 'MusicID'>;
-interface MusicDefinition {
-    readonly id: MusicID;
-    readonly soundID: SoundID;
-    readonly loop: {
+    readonly loop?: {
         readonly from: number;
         readonly to: number;
-    } | undefined;
+    };
 }
 
 interface GameConfiguration {
@@ -299,7 +293,6 @@ interface GameSetupOptions {
     readonly fontAssetDefinitions: readonly AssetDefinition[];
     readonly soundAssetDefinitions: readonly AssetDefinition<SoundID>[];
     readonly soundDefinitions: Readonly<Record<SoundID, SoundDefinition>>;
-    readonly musicDefinitions: Readonly<Record<MusicID, MusicDefinition>>;
 }
 declare class Game {
     static get instance(): Game;
@@ -323,45 +316,75 @@ declare class Game {
     setResolution(resolution: number): void;
 }
 
-declare abstract class AudioContainer extends IDAttachable {
+interface SoundOptions {
+    readonly offset?: number;
+}
+declare class Sound extends IDAttachable {
+    static createByName(soundName: SoundID, options?: SoundOptions): Sound;
     protected _source: AudioBufferSourceNode;
     protected _gain: GainNode;
-    protected _startingTime: number;
-    protected readonly _time: Variable<number>;
-    readonly time: actions_lib.PersistentNotifier<number>;
-    constructor(output: AudioNode);
+    protected _head: AudioNode;
+    protected _soundDefinition: SoundDefinition;
+    protected _start: number;
     get volume(): number;
     set volume(value: number);
     setVolume(value: number): this;
+    constructor(soundDefinition: SoundDefinition, options?: SoundOptions);
+    destroy(): void;
+    protected _play(offset: number): void;
+    protected _stop(): void;
+}
+
+interface AdvancedSoundOptions extends SoundOptions {
+    readonly fade?: number;
+    readonly muffle?: number;
+}
+declare class AdvancedSound extends Sound {
+    static createByName(soundName: SoundID, options?: AdvancedSoundOptions): AdvancedSound;
+    readonly time: actions_lib.PersistentNotifier<number>;
+    constructor(soundDefinition: SoundDefinition, options?: AdvancedSoundOptions);
+    close(): IdleSingleEvent;
     /**
      * @param time in seconds
      * @returns IdleSingleEvent that resolves in the given time
      */
     notifyOnTime(targetTime: number): IdleSingleEvent;
+    setFade(strength: number): void;
+    fade(strength: number, transitionDuration?: number): IdleSingleEvent;
+    setMuffle(strength: number): void;
+    muffle(strength: number, transitionDuration?: number): IdleSingleEvent;
     destroy(): void;
-    protected _play(options: {
-        readonly soundID: SoundID;
-        readonly start: number;
-        readonly end: number;
-        readonly loop: boolean;
-        readonly onComplete?: () => void;
-    }): void;
 }
 
-interface MusicOptions {
-    readonly offset: number;
-    readonly muffle?: number;
+interface MusicOptions extends SoundOptions {
+    readonly stopPlayingOnPause: boolean;
 }
-declare class Music extends AudioContainer {
-    static createByName(musicName: MusicID, options?: MusicOptions): Music;
-    constructor(musicDefinition: MusicDefinition, options?: MusicOptions);
-    muffle(strength: number, transitionDuration?: number): IdleSingleEvent;
-    destroy(): void;
+declare class Music extends IDAttachable {
+    static createByName(soundName: SoundID, options?: MusicOptions): Music;
+    constructor(soundDefinition: SoundDefinition, partialOptions?: Partial<MusicOptions>);
+    /**
+     * Note: If then music time should stay synced with the game time, "stopPlayingOnPause" option has to be set true.
+     * @param time in seconds
+     * @returns IdleSingleEvent that resolves in the given time
+     */
+    notifyOnTime(targetTime: number): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
-declare class Sound extends AudioContainer {
-    static createByName(soundName: SoundID): Sound;
-    constructor(soundDefinition: SoundDefinition);
+interface MusicPlayerOptionsNoPause extends MusicOptions {
+    readonly stopPlayingOnPause: false;
+    readonly playWhenPaused: undefined;
+}
+interface MusicPlayerOptionsWithPause extends MusicOptions {
+    readonly stopPlayingOnPause: true;
+    readonly playWhenPaused: SoundID | undefined;
+}
+type MusicPlayerOptions = MusicPlayerOptionsNoPause | MusicPlayerOptionsWithPause;
+declare class MusicPlayer extends IDAttachable {
+    constructor(partialOptions?: Partial<MusicPlayerOptions>);
+    play(soundID: SoundID): IdleSingleEvent<Music | undefined>;
+    stop(): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
 declare enum ContainerEventType {
@@ -791,6 +814,8 @@ declare class Animator<T extends object = any, K extends NumericKeys<T> = Numeri
     get animating(): boolean;
     get target(): T;
     get value(): Notifier<T>;
+    get paused(): boolean;
+    set paused(value: boolean);
     constructor(target: T & Record<K, number>, animatedProperties: K | K[], partialOptions?: Partial<AnimationOptions>);
     animate(values: Record<K, number>, partialOptions?: Partial<AnimationOptions>): SingleEvent<void>;
     set(values: Record<K, number>): void;
@@ -815,52 +840,40 @@ interface StateAnimationOptions {
     readonly duration: number;
     readonly animation: AnimatorAnimation;
 }
-declare enum AnimationState$1 {
-    Idle = 1,
-    Transitioning = 2,
-    Reverting = 3
+type AnimationState$2 = 'idle' | 'transitioning' | 'reverting';
+interface StateAnimationState<T, A> {
+    readonly value: number;
+    readonly item: T | undefined;
+    readonly nextItem: T | undefined;
+    readonly queuedItem: T | undefined;
+    readonly animationState: A;
 }
 declare class StateAnimation<T> extends Attachable {
-    get currentState(): {
-        value: number;
-        state: T | undefined;
-        nextState: T | undefined;
-        queuedState: T | undefined;
-        animationState: AnimationState$1;
-    };
+    onStateChange(callback: (item: T, nextItem?: T) => void): this;
+    onValueChange(callback: (value: number) => void): this;
+    get state(): StateAnimationState<T, AnimationState$2>;
+    get paused(): boolean;
+    set paused(value: boolean);
     constructor(partialOptions?: Partial<StateAnimationOptions>);
-    setState(state: T, options?: {
+    setItem(item: T, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: T, nextState?: T) => void): this;
-    onValueChange(callback: (value: number) => void): this;
 }
 
-declare enum AnimationState {
-    Hidden = 1,
-    Visible = 2,
-    Appearing = 3,
-    Disappearing = 4,
-    DisappearToChange = 5
-}
-declare class FadeInStateAnimation<T> extends Attachable {
-    get currentState(): {
-        value: number;
-        state: T | undefined;
-        queuedState: T | undefined;
-        animationState: AnimationState;
-    };
+type AnimationState$1 = 'hidden' | 'visible' | 'appearing' | 'disappearing' | 'disappearToChange';
+declare class ThroughEmptyStateAnimation<T> extends Attachable {
+    onStateChange(callback: (state: T | undefined) => void): this;
+    onValueChange(callback: (value: number) => void): this;
+    get state(): StateAnimationState<T, AnimationState$1>;
     constructor(partialOptions?: Partial<StateAnimationOptions>);
     /**
-     * @param state - The new state to set. Keep in mind falsy values are also considered as a new state. To set the state to "disappear" use undefined.
+     * @param item - The new item to set. Keep in mind falsy values are also considered as a new item. To set the item to "disappear" use undefined.
      * @param options - Optional options.
-     * @param options.instant - If true, the state will be set immediately.
+     * @param options.instant - If true, the item will be set immediately.
      */
-    setState(state: T | undefined, options?: {
+    setItem(item: T | undefined, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: T | undefined) => void): this;
-    onValueChange(callback: (value: number) => void): this;
 }
 
 declare enum ScrollDirection {
@@ -900,13 +913,15 @@ declare enum SlideStateAnimationState {
     Appear = 1,
     Disappear = 2
 }
+type AnimationState = 'idle' | 'transitionForward' | 'transitionBackward' | 'reverting';
 declare class SlideStateAnimation extends Attachable {
+    onStateChange(callback: (state: SlideStateAnimationState, index: number) => void): this;
+    onValueChange(callback: (value: number, index: number) => void): this;
+    get state(): StateAnimationState<number, AnimationState>;
     constructor(partialOptions?: Partial<StateAnimationOptions>);
     setIndex(index: number, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: SlideStateAnimationState, index: number) => void): this;
-    onValueChange(callback: (value: number, index: number) => void): this;
 }
 
 declare class VectorSet {
@@ -1300,4 +1315,4 @@ declare const PhysicsGateway_base: new () => PhysicsController;
 declare class PhysicsGateway extends PhysicsGateway_base {
 }
 
-export { AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsHardReset, BlendMode, type BorderProperties, Camera, CameraGateway, type CircleShapeData, ClosestAvailableSpaceHelper, type CollisionDetails, type CollisionReport, Container, ContainerEventType, ControllerDecorator, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, Gateway, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, type KeyboardKeyInfo, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, MenuEntity, type MenuOptions, MenuUI, MenuView, MouseService, MouseTargetFocusService, MovableEntity, MovablePhysicsEntity, Music, type MusicDefinition, type MusicID, type MusicIDRegistry, type PartialTextOptions, PathFinder, type PathFinderResult, type PhysicsBodyDTO, PhysicsEntity, type PhysicsEntityDefinition, type PhysicsExplosionOptions, PhysicsGateway, PhysicsShapeType, Placeholder, type PolygonDefinition, type PolygonShapeData, ROTATIONAL_SPEED_LIMIT, type RayCast, type RayCastHit, ReAnimateHandlingType, type RectangleShapeData, RichText, type RichTextOptions, type RichTextRectangleCut, type RichTextStyles, SPEED_LIMIT, Scene, SceneDecorator, ScrollAreaUI, ScrollDirection, type ScrollInContentOptions, ScrollMaskUI, Service, ServiceDecorator, type SetParentOptions, type ShapeDefinition, SingletonEntity, SlideInContent, SlideInContentByIndex, SlideStateAnimation, SlideStateAnimationState, Sound, type SoundDefinition, type SoundID, type SoundIDRegistry, Sprite, type SpriteDefinition, type SpriteID, type SpriteIDRegistry, StateAnimation, type StateAnimationOptions, Text, type TextAlignment, type TextOptions, UpdatableContainer, UpdateCycle, VectorFieldPathFinder, VectorSet, View, ViewDecorator, type ViewDecoratorMeta };
+export { AdvancedSound, type AdvancedSoundOptions, AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsHardReset, BlendMode, type BorderProperties, Camera, CameraGateway, type CircleShapeData, ClosestAvailableSpaceHelper, type CollisionDetails, type CollisionReport, Container, ContainerEventType, ControllerDecorator, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FocusingAnimation, Game, Gateway, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, type KeyboardKeyInfo, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, MenuEntity, type MenuOptions, MenuUI, MenuView, MouseService, MouseTargetFocusService, MovableEntity, MovablePhysicsEntity, Music, MusicPlayer, type MusicPlayerOptions, type PartialTextOptions, PathFinder, type PathFinderResult, type PhysicsBodyDTO, PhysicsEntity, type PhysicsEntityDefinition, type PhysicsExplosionOptions, PhysicsGateway, PhysicsShapeType, Placeholder, type PolygonDefinition, type PolygonShapeData, ROTATIONAL_SPEED_LIMIT, type RayCast, type RayCastHit, ReAnimateHandlingType, type RectangleShapeData, RichText, type RichTextOptions, type RichTextRectangleCut, type RichTextStyles, SOUND_TRANSITION_DURATION, SPEED_LIMIT, Scene, SceneDecorator, ScrollAreaUI, ScrollDirection, type ScrollInContentOptions, ScrollMaskUI, Service, ServiceDecorator, type SetParentOptions, type ShapeDefinition, SingletonEntity, SlideInContent, SlideInContentByIndex, SlideStateAnimation, SlideStateAnimationState, Sound, type SoundDefinition, type SoundID, type SoundIDRegistry, type SoundOptions, Sprite, type SpriteDefinition, type SpriteID, type SpriteIDRegistry, StateAnimation, type StateAnimationOptions, type StateAnimationState, Text, type TextAlignment, type TextOptions, ThroughEmptyStateAnimation, UpdatableContainer, UpdateCycle, VectorFieldPathFinder, VectorSet, View, ViewDecorator, type ViewDecoratorMeta };

package/dist/index.d.ts

@@ -144,6 +144,7 @@ declare abstract class View extends IDAttachable {
 }
 
 type AudioAppearTransitionType = 'ease' | 'instant';
+declare const SOUND_TRANSITION_DURATION = 800;
 declare class Audio {
     private constructor();
     setVolumes(volumes: {
@@ -216,7 +217,7 @@ declare class Camera {
     constructor();
     setPosition(position: Vector): void;
     setTransition(options: FocusingOptions): void;
-    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
+    appear(on: boolean, type?: CameraAppearTransitionType, delay?: number): IdleSingleEvent;
     screenPositonToStagePosition(screenPosition: Vector): Vector;
 }
 
@@ -266,17 +267,10 @@ type SoundID = DynamicID<SoundIDRegistry, 'SoundID'>;
 interface SoundDefinition {
     readonly id: SoundID;
     readonly duration: number;
-}
-interface MusicIDRegistry {
-}
-type MusicID = DynamicID<MusicIDRegistry, 'MusicID'>;
-interface MusicDefinition {
-    readonly id: MusicID;
-    readonly soundID: SoundID;
-    readonly loop: {
+    readonly loop?: {
         readonly from: number;
         readonly to: number;
-    } | undefined;
+    };
 }
 
 interface GameConfiguration {
@@ -299,7 +293,6 @@ interface GameSetupOptions {
     readonly fontAssetDefinitions: readonly AssetDefinition[];
     readonly soundAssetDefinitions: readonly AssetDefinition<SoundID>[];
     readonly soundDefinitions: Readonly<Record<SoundID, SoundDefinition>>;
-    readonly musicDefinitions: Readonly<Record<MusicID, MusicDefinition>>;
 }
 declare class Game {
     static get instance(): Game;
@@ -323,45 +316,75 @@ declare class Game {
     setResolution(resolution: number): void;
 }
 
-declare abstract class AudioContainer extends IDAttachable {
+interface SoundOptions {
+    readonly offset?: number;
+}
+declare class Sound extends IDAttachable {
+    static createByName(soundName: SoundID, options?: SoundOptions): Sound;
     protected _source: AudioBufferSourceNode;
     protected _gain: GainNode;
-    protected _startingTime: number;
-    protected readonly _time: Variable<number>;
-    readonly time: actions_lib.PersistentNotifier<number>;
-    constructor(output: AudioNode);
+    protected _head: AudioNode;
+    protected _soundDefinition: SoundDefinition;
+    protected _start: number;
     get volume(): number;
     set volume(value: number);
     setVolume(value: number): this;
+    constructor(soundDefinition: SoundDefinition, options?: SoundOptions);
+    destroy(): void;
+    protected _play(offset: number): void;
+    protected _stop(): void;
+}
+
+interface AdvancedSoundOptions extends SoundOptions {
+    readonly fade?: number;
+    readonly muffle?: number;
+}
+declare class AdvancedSound extends Sound {
+    static createByName(soundName: SoundID, options?: AdvancedSoundOptions): AdvancedSound;
+    readonly time: actions_lib.PersistentNotifier<number>;
+    constructor(soundDefinition: SoundDefinition, options?: AdvancedSoundOptions);
+    close(): IdleSingleEvent;
     /**
      * @param time in seconds
      * @returns IdleSingleEvent that resolves in the given time
      */
     notifyOnTime(targetTime: number): IdleSingleEvent;
+    setFade(strength: number): void;
+    fade(strength: number, transitionDuration?: number): IdleSingleEvent;
+    setMuffle(strength: number): void;
+    muffle(strength: number, transitionDuration?: number): IdleSingleEvent;
     destroy(): void;
-    protected _play(options: {
-        readonly soundID: SoundID;
-        readonly start: number;
-        readonly end: number;
-        readonly loop: boolean;
-        readonly onComplete?: () => void;
-    }): void;
 }
 
-interface MusicOptions {
-    readonly offset: number;
-    readonly muffle?: number;
+interface MusicOptions extends SoundOptions {
+    readonly stopPlayingOnPause: boolean;
 }
-declare class Music extends AudioContainer {
-    static createByName(musicName: MusicID, options?: MusicOptions): Music;
-    constructor(musicDefinition: MusicDefinition, options?: MusicOptions);
-    muffle(strength: number, transitionDuration?: number): IdleSingleEvent;
-    destroy(): void;
+declare class Music extends IDAttachable {
+    static createByName(soundName: SoundID, options?: MusicOptions): Music;
+    constructor(soundDefinition: SoundDefinition, partialOptions?: Partial<MusicOptions>);
+    /**
+     * Note: If then music time should stay synced with the game time, "stopPlayingOnPause" option has to be set true.
+     * @param time in seconds
+     * @returns IdleSingleEvent that resolves in the given time
+     */
+    notifyOnTime(targetTime: number): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
-declare class Sound extends AudioContainer {
-    static createByName(soundName: SoundID): Sound;
-    constructor(soundDefinition: SoundDefinition);
+interface MusicPlayerOptionsNoPause extends MusicOptions {
+    readonly stopPlayingOnPause: false;
+    readonly playWhenPaused: undefined;
+}
+interface MusicPlayerOptionsWithPause extends MusicOptions {
+    readonly stopPlayingOnPause: true;
+    readonly playWhenPaused: SoundID | undefined;
+}
+type MusicPlayerOptions = MusicPlayerOptionsNoPause | MusicPlayerOptionsWithPause;
+declare class MusicPlayer extends IDAttachable {
+    constructor(partialOptions?: Partial<MusicPlayerOptions>);
+    play(soundID: SoundID): IdleSingleEvent<Music | undefined>;
+    stop(): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
 declare enum ContainerEventType {
@@ -791,6 +814,8 @@ declare class Animator<T extends object = any, K extends NumericKeys<T> = Numeri
     get animating(): boolean;
     get target(): T;
     get value(): Notifier<T>;
+    get paused(): boolean;
+    set paused(value: boolean);
     constructor(target: T & Record<K, number>, animatedProperties: K | K[], partialOptions?: Partial<AnimationOptions>);
     animate(values: Record<K, number>, partialOptions?: Partial<AnimationOptions>): SingleEvent<void>;
     set(values: Record<K, number>): void;
@@ -815,52 +840,40 @@ interface StateAnimationOptions {
     readonly duration: number;
     readonly animation: AnimatorAnimation;
 }
-declare enum AnimationState$1 {
-    Idle = 1,
-    Transitioning = 2,
-    Reverting = 3
+type AnimationState$2 = 'idle' | 'transitioning' | 'reverting';
+interface StateAnimationState<T, A> {
+    readonly value: number;
+    readonly item: T | undefined;
+    readonly nextItem: T | undefined;
+    readonly queuedItem: T | undefined;
+    readonly animationState: A;
 }
 declare class StateAnimation<T> extends Attachable {
-    get currentState(): {
-        value: number;
-        state: T | undefined;
-        nextState: T | undefined;
-        queuedState: T | undefined;
-        animationState: AnimationState$1;
-    };
+    onStateChange(callback: (item: T, nextItem?: T) => void): this;
+    onValueChange(callback: (value: number) => void): this;
+    get state(): StateAnimationState<T, AnimationState$2>;
+    get paused(): boolean;
+    set paused(value: boolean);
     constructor(partialOptions?: Partial<StateAnimationOptions>);
-    setState(state: T, options?: {
+    setItem(item: T, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: T, nextState?: T) => void): this;
-    onValueChange(callback: (value: number) => void): this;
 }
 
-declare enum AnimationState {
-    Hidden = 1,
-    Visible = 2,
-    Appearing = 3,
-    Disappearing = 4,
-    DisappearToChange = 5
-}
-declare class FadeInStateAnimation<T> extends Attachable {
-    get currentState(): {
-        value: number;
-        state: T | undefined;
-        queuedState: T | undefined;
-        animationState: AnimationState;
-    };
+type AnimationState$1 = 'hidden' | 'visible' | 'appearing' | 'disappearing' | 'disappearToChange';
+declare class ThroughEmptyStateAnimation<T> extends Attachable {
+    onStateChange(callback: (state: T | undefined) => void): this;
+    onValueChange(callback: (value: number) => void): this;
+    get state(): StateAnimationState<T, AnimationState$1>;
     constructor(partialOptions?: Partial<StateAnimationOptions>);
     /**
-     * @param state - The new state to set. Keep in mind falsy values are also considered as a new state. To set the state to "disappear" use undefined.
+     * @param item - The new item to set. Keep in mind falsy values are also considered as a new item. To set the item to "disappear" use undefined.
      * @param options - Optional options.
-     * @param options.instant - If true, the state will be set immediately.
+     * @param options.instant - If true, the item will be set immediately.
      */
-    setState(state: T | undefined, options?: {
+    setItem(item: T | undefined, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: T | undefined) => void): this;
-    onValueChange(callback: (value: number) => void): this;
 }
 
 declare enum ScrollDirection {
@@ -900,13 +913,15 @@ declare enum SlideStateAnimationState {
     Appear = 1,
     Disappear = 2
 }
+type AnimationState = 'idle' | 'transitionForward' | 'transitionBackward' | 'reverting';
 declare class SlideStateAnimation extends Attachable {
+    onStateChange(callback: (state: SlideStateAnimationState, index: number) => void): this;
+    onValueChange(callback: (value: number, index: number) => void): this;
+    get state(): StateAnimationState<number, AnimationState>;
     constructor(partialOptions?: Partial<StateAnimationOptions>);
     setIndex(index: number, options?: {
         instant?: boolean;
     }): void;
-    onStateChange(callback: (state: SlideStateAnimationState, index: number) => void): this;
-    onValueChange(callback: (value: number, index: number) => void): this;
 }
 
 declare class VectorSet {
@@ -1300,4 +1315,4 @@ declare const PhysicsGateway_base: new () => PhysicsController;
 declare class PhysicsGateway extends PhysicsGateway_base {
 }
 
-export { AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsHardReset, BlendMode, type BorderProperties, Camera, CameraGateway, type CircleShapeData, ClosestAvailableSpaceHelper, type CollisionDetails, type CollisionReport, Container, ContainerEventType, ControllerDecorator, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, Gateway, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, type KeyboardKeyInfo, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, MenuEntity, type MenuOptions, MenuUI, MenuView, MouseService, MouseTargetFocusService, MovableEntity, MovablePhysicsEntity, Music, type MusicDefinition, type MusicID, type MusicIDRegistry, type PartialTextOptions, PathFinder, type PathFinderResult, type PhysicsBodyDTO, PhysicsEntity, type PhysicsEntityDefinition, type PhysicsExplosionOptions, PhysicsGateway, PhysicsShapeType, Placeholder, type PolygonDefinition, type PolygonShapeData, ROTATIONAL_SPEED_LIMIT, type RayCast, type RayCastHit, ReAnimateHandlingType, type RectangleShapeData, RichText, type RichTextOptions, type RichTextRectangleCut, type RichTextStyles, SPEED_LIMIT, Scene, SceneDecorator, ScrollAreaUI, ScrollDirection, type ScrollInContentOptions, ScrollMaskUI, Service, ServiceDecorator, type SetParentOptions, type ShapeDefinition, SingletonEntity, SlideInContent, SlideInContentByIndex, SlideStateAnimation, SlideStateAnimationState, Sound, type SoundDefinition, type SoundID, type SoundIDRegistry, Sprite, type SpriteDefinition, type SpriteID, type SpriteIDRegistry, StateAnimation, type StateAnimationOptions, Text, type TextAlignment, type TextOptions, UpdatableContainer, UpdateCycle, VectorFieldPathFinder, VectorSet, View, ViewDecorator, type ViewDecoratorMeta };
+export { AdvancedSound, type AdvancedSoundOptions, AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsHardReset, BlendMode, type BorderProperties, Camera, CameraGateway, type CircleShapeData, ClosestAvailableSpaceHelper, type CollisionDetails, type CollisionReport, Container, ContainerEventType, ControllerDecorator, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FocusingAnimation, Game, Gateway, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, type KeyboardKeyInfo, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, MenuEntity, type MenuOptions, MenuUI, MenuView, MouseService, MouseTargetFocusService, MovableEntity, MovablePhysicsEntity, Music, MusicPlayer, type MusicPlayerOptions, type PartialTextOptions, PathFinder, type PathFinderResult, type PhysicsBodyDTO, PhysicsEntity, type PhysicsEntityDefinition, type PhysicsExplosionOptions, PhysicsGateway, PhysicsShapeType, Placeholder, type PolygonDefinition, type PolygonShapeData, ROTATIONAL_SPEED_LIMIT, type RayCast, type RayCastHit, ReAnimateHandlingType, type RectangleShapeData, RichText, type RichTextOptions, type RichTextRectangleCut, type RichTextStyles, SOUND_TRANSITION_DURATION, SPEED_LIMIT, Scene, SceneDecorator, ScrollAreaUI, ScrollDirection, type ScrollInContentOptions, ScrollMaskUI, Service, ServiceDecorator, type SetParentOptions, type ShapeDefinition, SingletonEntity, SlideInContent, SlideInContentByIndex, SlideStateAnimation, SlideStateAnimationState, Sound, type SoundDefinition, type SoundID, type SoundIDRegistry, type SoundOptions, Sprite, type SpriteDefinition, type SpriteID, type SpriteIDRegistry, StateAnimation, type StateAnimationOptions, type StateAnimationState, Text, type TextAlignment, type TextOptions, ThroughEmptyStateAnimation, UpdatableContainer, UpdateCycle, VectorFieldPathFinder, VectorSet, View, ViewDecorator, type ViewDecoratorMeta };