bard-legends-framework 1.11.4 → 1.12.0

package/dist/index.d.ts

@@ -1,8 +1,21 @@
 import * as actions_lib from 'actions-lib';
-import { IDAttachable, AttachmentID, Attachable, IdleSingleEvent, IdleSequence, Variable, Reducer, Sequence, SingleNotifier, Notifier, SingleEvent, Action, ClassID, NotifierCallbackFunction, IAttachment } from 'actions-lib';
+import { IdleSingleEvent, IDAttachable, AttachmentID, Attachable, 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';
+import p2$1 from 'p2';
+import { LayoutStyles } from '@pixi/layout';
+
+type AudioAppearTransitionType = 'ease' | 'instant';
+declare const SOUND_TRANSITION_DURATION = 1000;
+declare class Audio {
+    private constructor();
+    setVolumes(volumes: {
+        master: number;
+        music: number;
+        sound: number;
+    }): void;
+    appear(on: boolean, type?: AudioAppearTransitionType): IdleSingleEvent;
+}
 
 /**
  * Binds a controller to its gateway (the class produced by `Gateway<T>()`). The controller must
@@ -158,18 +171,6 @@ declare abstract class View extends IDAttachable {
     update: (time: number, delta: number) => void;
 }
 
-type AudioAppearTransitionType = 'ease' | 'instant';
-declare const SOUND_TRANSITION_DURATION = 1000;
-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;
@@ -322,9 +323,14 @@ declare class Game {
     readonly devMode: boolean;
     constructor(partialConfiguration?: Partial<GameConfiguration>);
     setup(setupOptions: GameSetupOptions): Promise<void>;
+    generateTexture(options: Pixi.GenerateTextureOptions | Pixi.Container): Pixi.Texture;
     setResolution(resolution: number): void;
 }
 
+declare class ElectronGame {
+    static start(configuration: Partial<Omit<GameConfiguration, 'devMode' | 'maxScreenResolution'>>, setupOptions: GameSetupOptions): Promise<Game>;
+}
+
 interface SoundOptions {
     readonly time?: number;
     readonly volume?: number;
@@ -407,40 +413,17 @@ declare class MusicPlayer extends IDAttachable {
     close(): IdleSingleEvent;
 }
 
-declare enum ContainerEventType {
-    Click = "click",
-    MouseOver = "mouseover",
-    MouseOut = "mouseout",
-    PointerDown = "pointerdown",
-    PointerUp = "pointerup",
-    PointerUpOutside = "pointerupoutside",
-    PointerMove = "pointermove",
-    PointerCancel = "pointercancel",
-    PointerOver = "pointerover",
-    PointerOut = "pointerout",
-    PointerEnter = "pointerenter",
-    PointerLeave = "pointerleave",
-    Added = "added",
-    Removed = "removed",
-    Update = "update",
-    Change = "change",
-    Wheel = "wheel"
+interface PixiDisplayObject {
+    x: number;
+    y: number;
+    rotation: number;
+    alpha: number;
 }
-type ContainerEventTypeToResultType = {
-    [K in ContainerEventType]: K extends ContainerEventType.Wheel ? {
-        deltaY: number;
-    } : undefined;
-};
-declare enum Cursor {
-    Default = "default",
-    Pointer = "pointer"
-}
-declare abstract class ContainerAttributes extends IDAttachable {
-    protected constructor();
-    get size(): Vector;
-    set size(value: Vector);
-    getSize(): Vector;
-    setSize(value: Vector): this;
+declare abstract class DisplayObjectAttributes extends IDAttachable {
+    protected readonly _pixiDisplayObject: PixiDisplayObject;
+    protected constructor(_pixiDisplayObject: PixiDisplayObject);
+    protected abstract _applyScale(x: number, y: number): void;
+    protected abstract _getHoldFromModifier(holdFrom: Vector): Vector;
     /**
      * @param value The position to set
      * @param options.holdFrom An anchor point to hold the position from
@@ -457,7 +440,6 @@ declare abstract class ContainerAttributes extends IDAttachable {
     set x(value: number);
     get y(): number;
     set y(value: number);
-    on<T extends ContainerEventType>(eventType: T): Sequence<ContainerEventTypeToResultType[T]>;
     setRotation(value: Radian): this;
     get rotation(): Radian;
     set rotation(value: Radian);
@@ -466,38 +448,9 @@ declare abstract class ContainerAttributes extends IDAttachable {
      */
     get rotationValue(): number;
     set rotationValue(value: number);
-    setZIndex(value: number): this;
-    get zIndex(): number;
-    set zIndex(value: number);
-    setSkewX(radian: Radian): this;
-    get skewX(): Radian;
-    set skewX(radian: Radian);
-    setSkewY(radian: Radian): this;
-    get skewY(): Radian;
-    set skewY(radian: Radian);
-    setSortableChildren(value: boolean): this;
-    get sortableChildren(): boolean;
-    set sortableChildren(value: boolean);
     setAlpha(value: number): this;
     get alpha(): number;
     set alpha(value: number);
-    setInteractive(value: boolean): this;
-    get interactive(): boolean;
-    set interactive(value: boolean);
-    /**
-     * Renders this subtree as an isolated render group: its cached render instructions are not
-     * rebuilt when other parts of the scene change, and moving the group only updates one transform.
-     * Use for subtrees that move as a whole (world under a camera) or rarely change (HUD vs world).
-     */
-    setRenderGroup(value?: boolean): this;
-    setCursor(value: Cursor): this;
-    get cursor(): Cursor;
-    set cursor(value: Cursor);
-    protected getMask(): Pixi.Container;
-    setMask(mask: ContainerAttributes | undefined): this;
-    hitTest(stagePosition: Vector): boolean;
-    get boundingBox(): Rectangle;
-    ignoreBounds(value?: boolean): this;
     setMirror(mirror?: boolean): this;
     get mirror(): boolean;
     set mirror(value: boolean);
@@ -572,11 +525,40 @@ declare class Sprite extends Container {
     download(): this;
 }
 
+type LayoutStyle = LayoutStyles;
+declare enum ContainerEventType {
+    Click = "click",
+    MouseOver = "mouseover",
+    MouseOut = "mouseout",
+    PointerDown = "pointerdown",
+    PointerUp = "pointerup",
+    PointerUpOutside = "pointerupoutside",
+    PointerMove = "pointermove",
+    PointerCancel = "pointercancel",
+    PointerOver = "pointerover",
+    PointerOut = "pointerout",
+    PointerEnter = "pointerenter",
+    PointerLeave = "pointerleave",
+    Added = "added",
+    Removed = "removed",
+    Update = "update",
+    Change = "change",
+    Wheel = "wheel"
+}
+type ContainerEventTypeToResultType = {
+    [K in ContainerEventType]: K extends ContainerEventType.Wheel ? {
+        deltaY: number;
+    } : undefined;
+};
+declare enum Cursor {
+    Default = "default",
+    Pointer = "pointer"
+}
 interface SetParentOptions {
     addUnder: boolean;
     cropOverflowingParts: boolean;
 }
-declare class Container extends ContainerAttributes {
+declare class Container extends DisplayObjectAttributes {
     protected static allContainers: Map<number, Container>;
     readonly filters: Filters;
     protected addChildTo: Container;
@@ -584,8 +566,50 @@ declare class Container extends ContainerAttributes {
         addUnder: boolean;
         cropOverflowingParts: boolean;
     };
-    constructor();
+    constructor(pixiContainer?: Pixi.Container);
     destroy(): void;
+    protected _applyScale(x: number, y: number): void;
+    protected _getHoldFromModifier(holdFrom: Vector): Vector;
+    get size(): Vector;
+    set size(value: Vector);
+    getSize(): Vector;
+    setSize(value: Vector): this;
+    /**
+     * Makes this object a flex item of a LayoutContainer parent, treated as a box measured by its bounds.
+     * @param style Optional per-item overrides (alignSelf, margins, width, height...)
+     * @returns this
+     */
+    setLayout(style?: LayoutStyle): this;
+    on<T extends ContainerEventType>(eventType: T): Sequence<ContainerEventTypeToResultType[T]>;
+    setZIndex(value: number): this;
+    get zIndex(): number;
+    set zIndex(value: number);
+    setSkewX(radian: Radian): this;
+    get skewX(): Radian;
+    set skewX(radian: Radian);
+    setSkewY(radian: Radian): this;
+    get skewY(): Radian;
+    set skewY(radian: Radian);
+    setSortableChildren(value: boolean): this;
+    get sortableChildren(): boolean;
+    set sortableChildren(value: boolean);
+    setInteractive(value: boolean): this;
+    get interactive(): boolean;
+    set interactive(value: boolean);
+    /**
+     * Renders this subtree as an isolated render group: its cached render instructions are not
+     * rebuilt when other parts of the scene change, and moving the group only updates one transform.
+     * Use for subtrees that move as a whole (world under a camera) or rarely change (HUD vs world).
+     */
+    setRenderGroup(value?: boolean): this;
+    setCursor(value: Cursor): this;
+    get cursor(): Cursor;
+    set cursor(value: Cursor);
+    protected getMask(): Pixi.Container;
+    setMask(mask: Container | undefined): this;
+    hitTest(stagePosition: Vector): boolean;
+    get boundingBox(): Rectangle;
+    ignoreBounds(value?: boolean): this;
     getBoundingMask(): Sprite;
     displayParent(parent: Container | number, partialOptions?: Partial<SetParentOptions>): this;
 }
@@ -982,6 +1006,16 @@ declare class ScrollMaskUI extends Container {
     constructor(container: Container, size: Vector, padding: number, direction?: ScrollDirection);
 }
 
+/**
+ * A flexbox container.
+ */
+declare class LayoutContainer extends Container {
+    constructor(style?: LayoutStyle);
+    setLayout(style: LayoutStyle): this;
+    debug(): this;
+    debugBackground(): this;
+}
+
 interface KeyboardKeyInfo {
     readonly key: string;
     readonly code: string;
@@ -1342,4 +1376,26 @@ declare abstract class MovablePhysicsEntity extends PhysicsEntity {
     convertToDTO(): PhysicsBodyDTO;
 }
 
-export { AdvancedSound, type AdvancedSoundOptions, AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsTestingHelper, type 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 EntityID, 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, type PhysicsWorldID, 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 };
+interface ElectronAppOptions {
+    readonly devMode: boolean;
+    readonly maxScreenResolution: {
+        readonly width: number;
+        readonly height: number;
+    } | undefined;
+}
+interface ElectronBridge {
+    save(data: string | undefined, fileName: string): Promise<void>;
+    load(fileName: string): Promise<string | undefined>;
+    getOptions(): Promise<ElectronAppOptions>;
+    setFullScreen(fullScreen: boolean): void;
+    rendererReady(): void;
+    onWindowFocus(callback: (focused: boolean) => void): () => void;
+    quit(): void;
+}
+declare global {
+    interface Window {
+        api: ElectronBridge;
+    }
+}
+
+export { AdvancedSound, type AdvancedSoundOptions, AnimationFlicker, AnimationInterpolationFunctions, type AnimationOptions, Animations, AnimationsCompletionHandlingType, Animator, type AnimatorAnimation, type AssetDefinition, type AudioAppearTransitionType, BORDER_MATERIAL_NAME, BardLegendsTestingHelper, type 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, type ElectronAppOptions, type ElectronBridge, ElectronGame, Entity, EntityDecorator, type EntityID, type ExplosionHit, FadeInContent, type FadeInContentOptions, FocusingAnimation, Game, Gateway, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, type KeyboardKeyInfo, KeyboardService, LayoutContainer, type LayoutStyle, 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, type PhysicsWorldID, 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 };