bard-legends-framework 1.6.0 → 1.7.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as actions_lib from 'actions-lib';
-import { IDAttachable, Attachable, AttachmentID, IdleSingleEvent, IdleSequence, Sequence, SingleNotifier, Notifier, SingleEvent, Variable, Reducer, Action, ClassID, NotifierCallbackFunction, IAttachment } from 'actions-lib';
-import { Vector, Radian, Rectangle, Vec2, RGBColor, Grid, GridNeighborType, Line } from 'helpers-lib';
+import { IDAttachable, Attachable, AttachmentID, IdleSingleEvent, IdleSequence, Variable, Reducer, Sequence, SingleNotifier, Notifier, SingleEvent, Action, ClassID, NotifierCallbackFunction, IAttachment } from 'actions-lib';
+import { Vector, DynamicID, Vec2, RGBColor, Radian, Rectangle, Grid, GridNeighborType, Line } from 'helpers-lib';
 import p2$1 from 'p2';
 import * as Pixi from 'pixi.js';
 
@@ -96,7 +96,6 @@ declare abstract class Scene<InputType, OutputType> extends IDAttachable {
     readonly onClose: actions_lib.PersistentSingleNotifier<OutputType>;
     constructor();
     close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): IdleSingleEvent<OutputType>;
-    private animateAndClose;
     protected abstract init(input: InputType): IdleSingleEvent;
     protected abstract update(time: number, delta: number): void;
     protected abstract prepareToClose(): IdleSingleEvent;
@@ -144,6 +143,227 @@ declare abstract class View extends IDAttachable {
     update(time: number, delta: number): void;
 }
 
+type AudioAppearTransitionType = 'ease' | 'instant';
+declare class Audio {
+    private constructor();
+    setVolumes(volumes: {
+        master: number;
+        music: number;
+        sound: number;
+    }): void;
+    appear(on: boolean, type?: AudioAppearTransitionType): IdleSingleEvent;
+}
+
+interface FocusingNewTargetInfo {
+    time: number;
+    duration: number;
+    position: Vector;
+    roundPosition: boolean;
+    roundPositionThreshold: number;
+    focusingAnimation: FocusingAnimation;
+}
+declare class CameraEntity extends SingletonEntity {
+    readonly position: Variable<Vector>;
+    readonly offset: Variable<Vector>;
+    readonly targetPosition: Variable<Vector | undefined>;
+    readonly focusingNewTargetInfo: Variable<FocusingNewTargetInfo | undefined>;
+}
+
+declare class CameraService {
+    createCamera(): CameraEntity;
+    getCameraPosition(): Vector;
+    setPosition(position: Vector): void;
+    setTransition(options: FocusingOptions): void;
+    update(time: number, delta: number): void;
+}
+
+declare enum CameraLayer {
+    BackgroundScreen = "backgroundScreen",
+    Background = "background",
+    Main = "main",
+    Foreground = "foreground",
+    ForegroundScreen = "foregroundScreen"
+}
+declare enum FocusingAnimation {
+    Instant = 1,
+    EaseInOut = 2,
+    EaseOut = 3
+}
+interface FocusingOptions {
+    duration?: number;
+    animation?: FocusingAnimation;
+    roundPosition?: boolean;
+    roundPositionThreshold?: number;
+}
+type CameraAppearTransitionType = 'alpha' | 'pureBlack' | 'instant';
+
+declare class CameraController {
+    constructor(_cameraService: CameraService);
+    createCamera(): number;
+    update(time: number, delta: number): void;
+    setPosition(position: Vector): void;
+    setTransition(options: FocusingOptions): void;
+    getCameraPosition(): Vector;
+}
+
+declare const CameraGateway_base: new () => CameraController;
+declare class CameraGateway extends CameraGateway_base {
+}
+
+declare class Camera {
+    readonly layers: Record<CameraLayer, number>;
+    get position(): Vector;
+    constructor();
+    setPosition(position: Vector): void;
+    setTransition(options: FocusingOptions): void;
+    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
+    screenPositonToStagePosition(screenPosition: Vector): Vector;
+}
+
+declare const DEFAULT_SHADER_RESOLUTION = 2;
+interface AssetDefinition<T = string> {
+    readonly id: T;
+    readonly url: string;
+}
+declare enum BlendMode {
+    Normal = 0,
+    Add = 1,
+    Screen = 3,
+    Luminosity = 16,
+    ColorDodge = 7
+}
+interface SpriteIDRegistry {
+}
+type SpriteID = DynamicID<SpriteIDRegistry, 'SpriteID'>;
+interface SpriteDefinition {
+    readonly id: SpriteID;
+    readonly scale: number;
+    readonly anchor: Vec2;
+    readonly size: Vec2;
+    readonly boundingShapes?: PolygonDefinition | undefined;
+    readonly destroyAssetOnDestroy?: boolean | undefined;
+}
+interface GlowingShapeDefinition {
+    readonly color: RGBColor;
+    readonly shapeAlpha: number;
+    readonly glowAlpha: number;
+    readonly glowOptions: GlowOptions;
+    readonly shapes: PolygonDefinition;
+}
+type PolygonDefinition = readonly (readonly Vec2[])[];
+interface GlowOptions {
+    readonly color: RGBColor;
+    readonly blurRadius: number | Vector;
+    readonly expand: number;
+    readonly blendMode: BlendMode;
+}
+type GlowEffectOptions = Partial<GlowOptions> & {
+    glowAlpha?: number;
+};
+interface SoundIDRegistry {
+}
+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 from: number;
+        readonly to: number;
+    } | undefined;
+}
+
+interface GameConfiguration {
+    readonly screenResolution: {
+        readonly width: number;
+        readonly height: number;
+    } | undefined;
+    readonly maxScreenResolution: {
+        readonly width: number;
+        readonly height: number;
+    } | undefined;
+    readonly devMode: boolean;
+    readonly backgroundColor: RGBColor;
+    readonly antialias: boolean;
+    readonly resolution: number;
+}
+interface GameSetupOptions {
+    readonly spriteAssetDefinitions: readonly AssetDefinition<SpriteID>[];
+    readonly spriteDefinitions: Readonly<Record<SpriteID, SpriteDefinition>>;
+    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;
+    static readonly pause: Reducer<boolean, boolean>;
+    static readonly freeze: Reducer<boolean, boolean>;
+    static get camera(): Camera;
+    static get audio(): Audio;
+    static appear(on: boolean, options?: {
+        camera?: CameraAppearTransitionType;
+        audio?: AudioAppearTransitionType;
+    }): IdleSingleEvent;
+    static get time(): number;
+    readonly renderer: Pixi.Renderer;
+    readonly _screenSize: Variable<Vector>;
+    readonly screenSize: actions_lib.PersistentNotifier<Vector>;
+    readonly _screenSizeCenter: Variable<Vector>;
+    readonly screenSizeCenter: actions_lib.PersistentNotifier<Vector>;
+    readonly devMode: boolean;
+    constructor(partialConfiguration?: Partial<GameConfiguration>);
+    setup(setupOptions: GameSetupOptions): Promise<void>;
+    setResolution(resolution: number): void;
+}
+
+declare abstract class AudioContainer extends IDAttachable {
+    protected _source: AudioBufferSourceNode;
+    protected _gain: GainNode;
+    protected _startingTime: number;
+    protected readonly _time: Variable<number>;
+    readonly time: actions_lib.PersistentNotifier<number>;
+    constructor(output: AudioNode);
+    get volume(): number;
+    set volume(value: number);
+    setVolume(value: number): this;
+    /**
+     * @param time in seconds
+     * @returns IdleSingleEvent that resolves in the given time
+     */
+    notifyOnTime(targetTime: 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;
+}
+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 Sound extends AudioContainer {
+    static createByName(soundName: SoundID): Sound;
+    constructor(soundDefinition: SoundDefinition);
+}
+
 declare enum ContainerEventType {
     Click = "click",
     MouseOver = "mouseover",
@@ -260,51 +480,13 @@ declare class Filters {
     removeColorFilter(): void;
 }
 
-declare const DEFAULT_SHADER_RESOLUTION = 2;
-interface AssetDefinition<T extends string = string> {
-    readonly id: string;
-    readonly url: T;
-}
-declare enum BlendMode {
-    Normal = 0,
-    Add = 1,
-    Screen = 3,
-    Luminosity = 16,
-    ColorDodge = 7
-}
-interface SpriteDefinition {
-    readonly id: string;
-    readonly scale: number;
-    readonly anchor: Vec2;
-    readonly size: Vec2;
-    readonly boundingShapes?: PolygonDefinition | undefined;
-    readonly destroyAssetOnDestroy?: boolean | undefined;
-}
-interface GlowingShapeDefinition {
-    readonly color: RGBColor;
-    readonly shapeAlpha: number;
-    readonly glowAlpha: number;
-    readonly glowOptions: GlowOptions;
-    readonly shapes: PolygonDefinition;
-}
-type PolygonDefinition = readonly (readonly Vec2[])[];
-interface GlowOptions {
-    readonly color: RGBColor;
-    readonly blurRadius: number | Vector;
-    readonly expand: number;
-    readonly blendMode: BlendMode;
-}
-type GlowEffectOptions = Partial<GlowOptions> & {
-    glowAlpha?: number;
-};
-
 interface SpriteOptions {
     readonly textureSize?: Vector;
     readonly texturePosition?: Vector;
     readonly ignoreAnchor?: boolean;
 }
 declare class Sprite extends Container {
-    static createByName(spriteName: string): Sprite;
+    static createByName(spriteName: SpriteID): Sprite;
     static createSnapshotSprite(container: Container): Sprite;
     readonly pixiSprite: Pixi.Sprite;
     constructor(spriteDefinition: SpriteDefinition, options?: SpriteOptions);
@@ -480,7 +662,7 @@ declare class MenuUI extends Container {
     readonly onCreate: actions_lib.PersistentSingleNotifier<void>;
     readonly onOpen: actions_lib.PersistentSingleNotifier<void>;
     readonly onClose: actions_lib.PersistentSingleNotifier<void>;
-    constructor(windowSprite: string, partialOptions: Partial<MenuOptions>);
+    constructor(windowSprite: SpriteID, partialOptions: Partial<MenuOptions>);
     getBoundingMask(): Sprite;
     close(): IdleSingleEvent;
 }
@@ -489,7 +671,7 @@ interface MenuEntityOptions {
     readonly closeOnBackgroundClick: boolean;
 }
 declare class MenuEntity extends SingletonEntity {
-    static subscribeIsOpen(): IdleSequence<boolean>;
+    static subscribeIsOpen(): Sequence<boolean>;
     constructor(partialOptions: Partial<MenuEntityOptions>);
     onCreate(): IdleSingleEvent;
     onOpen(): IdleSingleEvent;
@@ -505,7 +687,7 @@ declare class MenuView extends View {
     readonly onCreate: SingleNotifier<Container>;
     readonly onOpen: SingleNotifier;
     readonly onClose: SingleNotifier;
-    constructor(entity: MenuEntity, windowSprite: string, partialOptions: Partial<MenuViewOptions>);
+    constructor(entity: MenuEntity, windowSprite: SpriteID, partialOptions: Partial<MenuViewOptions>);
 }
 
 interface ScrollAreaUIOptions {
@@ -532,6 +714,8 @@ declare class AnimationInterpolationFunctions {
     static lineer(time: number): number;
     static easeIn(time: number): number;
     static easeOut(time: number): number;
+    static easeInCubic(time: number): number;
+    static easeOutCubic(time: number): number;
     static easeInOut(time: number): number;
     static easeInOutCubic(t: number): number;
     static blink(t: number): number;
@@ -552,6 +736,14 @@ declare class AnimationEaseInOut implements AnimatorAnimation {
     start(): void;
     multiplierFunction(t: number): number;
 }
+declare class AnimationEaseInCubic implements AnimatorAnimation {
+    start(): void;
+    multiplierFunction(t: number): number;
+}
+declare class AnimationEaseOutCubic implements AnimatorAnimation {
+    start(): void;
+    multiplierFunction(t: number): number;
+}
 declare class AnimationEaseInOutCubic implements AnimatorAnimation {
     start(): void;
     multiplierFunction(t: number): number;
@@ -569,6 +761,8 @@ declare class Animations {
     static easeIn: AnimationEaseIn;
     static easeOut: AnimationEaseOut;
     static easeInOut: AnimationEaseInOut;
+    static easeInCubic: AnimationEaseInCubic;
+    static easeOutCubic: AnimationEaseOutCubic;
     static easeInOutCubic: AnimationEaseInOutCubic;
     static blink: AnimationBlink;
 }
@@ -747,115 +941,6 @@ declare class ScrollMaskUI extends Container {
     constructor(container: Container, size: Vector, padding: number, direction?: ScrollDirection);
 }
 
-interface FocusingNewTargetInfo {
-    time: number;
-    duration: number;
-    position: Vector;
-    roundPosition: boolean;
-    roundPositionThreshold: number;
-    focusingAnimation: FocusingAnimation;
-}
-declare class CameraEntity extends SingletonEntity {
-    readonly position: Variable<Vector>;
-    readonly offset: Variable<Vector>;
-    readonly targetPosition: Variable<Vector | undefined>;
-    readonly focusingNewTargetInfo: Variable<FocusingNewTargetInfo | undefined>;
-}
-
-declare class CameraService {
-    createCamera(): CameraEntity;
-    getCameraPosition(): Vector;
-    setPosition(position: Vector): void;
-    setTransition(options: FocusingOptions): void;
-    update(time: number, delta: number): void;
-}
-
-declare enum CameraLayer {
-    BackgroundScreen = "backgroundScreen",
-    Background = "background",
-    Main = "main",
-    Foreground = "foreground",
-    ForegroundScreen = "foregroundScreen"
-}
-declare enum FocusingAnimation {
-    Instant = 1,
-    EaseInOut = 2,
-    EaseOut = 3
-}
-interface FocusingOptions {
-    duration?: number;
-    animation?: FocusingAnimation;
-    roundPosition?: boolean;
-    roundPositionThreshold?: number;
-}
-type CameraAppearTransitionType = 'alpha' | 'pureBlack' | 'instant';
-
-declare class CameraController {
-    constructor(_cameraService: CameraService);
-    createCamera(): number;
-    update(time: number, delta: number): void;
-    setPosition(position: Vector): void;
-    setTransition(options: FocusingOptions): void;
-    getCameraPosition(): Vector;
-}
-
-declare const CameraGateway_base: new () => CameraController;
-declare class CameraGateway extends CameraGateway_base {
-}
-
-declare class Camera {
-    readonly layers: Record<CameraLayer, number>;
-    get position(): Vector;
-    constructor();
-    setPosition(position: Vector): void;
-    setTransition(options: FocusingOptions): void;
-    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
-}
-
-interface GameConfiguration {
-    readonly screenResolution: {
-        readonly width: number;
-        readonly height: number;
-    } | undefined;
-    readonly maxScreenResolution: {
-        readonly width: number;
-        readonly height: number;
-    } | undefined;
-    readonly devMode: boolean;
-    readonly backgroundColor: RGBColor;
-    readonly antialias: boolean;
-    readonly resolution: number;
-}
-interface GameSetupOptions {
-    readonly assetDefinitions: readonly AssetDefinition<string>[];
-    readonly spriteDefinitions: Readonly<Record<string, SpriteDefinition>>;
-}
-declare class Game {
-    static get instance(): Game;
-    static readonly pause: Reducer<boolean, boolean>;
-    static get camera(): Camera;
-    static get time(): number;
-    readonly stage: Container;
-    readonly renderer: Pixi.Renderer;
-    readonly _screenSize: Variable<Vector>;
-    readonly screenSize: actions_lib.PersistentNotifier<Vector>;
-    readonly _screenSizeCenter: Variable<Vector>;
-    readonly screenSizeCenter: actions_lib.PersistentNotifier<Vector>;
-    readonly devMode: boolean;
-    constructor(partialConfiguration?: Partial<GameConfiguration>);
-    setup(setupOptions: GameSetupOptions): Promise<void>;
-    setResolution(resolution: number): void;
-    screenPositonToStagePosition(screenPosition: Vector): Vector;
-    setScreenPositionToStagePositionFunction(converterFunction: (screenPosition: Vector) => Vector): void;
-    resetScreenPositionToStagePositionFunction(): void;
-    destroyAsset(assetID: string): void;
-}
-
-declare class PositionConversionHelper {
-    static includeScaleInScreenPosition(screenPosition: Vector, gameInstanceScale: number, screenSizeCenter: Vector): Vector;
-    static normalizePolygonByAnchor(polygon: PolygonDefinition, frameSize: Vector, frameAnchor: Vector): PolygonDefinition;
-}
-
 interface KeyboardKeyInfo {
     readonly key: string;
     readonly code: string;
@@ -883,7 +968,6 @@ declare class MouseService {
      * accounting for canvas offset (e.g. letterboxing when max resolution is smaller than the window)
      * and CSS scaling of the canvas.
      */
-    private clientPositionToScreenPosition;
 }
 
 declare class MouseTargetFocusService {
@@ -1216,4 +1300,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, 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, type PartialTextOptions, PathFinder, type PathFinderResult, type PhysicsBodyDTO, PhysicsEntity, type PhysicsEntityDefinition, type PhysicsExplosionOptions, PhysicsGateway, PhysicsShapeType, Placeholder, type PolygonDefinition, type PolygonShapeData, PositionConversionHelper, 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, Sprite, type SpriteDefinition, StateAnimation, type StateAnimationOptions, Text, type TextAlignment, type TextOptions, UpdatableContainer, UpdateCycle, VectorFieldPathFinder, VectorSet, View, ViewDecorator, type ViewDecoratorMeta };
+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 };