bard-legends-framework 1.4.8 → 1.5.1

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as actions_lib from 'actions-lib';
-import { IDAttachable, Attachable, SingleEvent, Sequence, SingleNotifier, Notifier, Reducer, Variable, Action } from 'actions-lib';
+import { IDAttachable, Attachable, AttachmentID, IdleSingleEvent, IdleSequence, Sequence, SingleNotifier, Notifier, SingleEvent, Reducer, Variable, Action, ClassID } from 'actions-lib';
 import { Vector, Radian, Rectangle, Vec2, RGBColor, Grid, GridNeighborType, Line } from 'helpers-lib';
 import * as Pixi from 'pixi.js';
 
@@ -22,7 +22,7 @@ declare abstract class Entity extends IDAttachable {
     constructor();
     destroy(): void;
     attach(parent: Attachable): this;
-    attachByID(id: number): this;
+    attachByID(id: AttachmentID): this;
     attachToRoot(): this;
 }
 
@@ -30,8 +30,8 @@ type SingletonEntityClassType<T extends SingletonEntity = SingletonEntity> = (ne
     id: number;
 };
 declare abstract class SingletonEntity extends Entity {
-    static getInstanceAsync<T extends SingletonEntity>(this: SingletonEntityClassType<T>): SingleEvent<T>;
-    static continuesSubscription<T extends SingletonEntity>(this: SingletonEntityClassType<T>): Sequence<{
+    static getInstanceAsync<T extends SingletonEntity>(this: SingletonEntityClassType<T>): IdleSingleEvent<T>;
+    static continuesSubscription<T extends SingletonEntity>(this: SingletonEntityClassType<T>): IdleSequence<{
         type: 'open' | 'close';
         value: T;
     }>;
@@ -49,23 +49,21 @@ type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
 type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
 declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
 declare abstract class Scene<InputType, OutputType> extends IDAttachable {
-    static readonly isTransitioning: actions_lib.Notifier<boolean>;
-    static getIsTransitioning(this: typeof Scene): boolean;
-    static readonly activeScene: actions_lib.Notifier<Scene<unknown, unknown> | undefined>;
-    static getActiveScene(this: typeof Scene): Scene<unknown, unknown> | undefined;
+    static readonly isTransitioning: actions_lib.PersistentNotifier<boolean>;
+    static readonly activeScene: actions_lib.PersistentNotifier<Scene<unknown, unknown> | undefined>;
     static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
-    static cancelActiveScene(): SingleEvent;
+    static cancelActiveScene(): IdleSingleEvent;
     static isActive<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): boolean;
     static getInstance<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T | undefined;
     static getInstanceOrFail<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T;
-    static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): SingleEvent<T>;
-    readonly onClose: actions_lib.SingleNotifier<OutputType>;
+    static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
+    readonly onClose: actions_lib.PersistentSingleNotifier<OutputType>;
     constructor();
-    close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): SingleEvent<OutputType>;
+    close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): IdleSingleEvent<OutputType>;
     private animateAndClose;
-    protected abstract init(input: InputType): SingleEvent;
+    protected abstract init(input: InputType): IdleSingleEvent;
     protected abstract update(time: number, delta: number): void;
-    protected abstract prepareToClose(): SingleEvent;
+    protected abstract prepareToClose(): IdleSingleEvent;
     /**
      * @deprecated
      */
@@ -90,7 +88,7 @@ declare class UpdateCycle {
         time: number;
         delta: number;
     }>;
-    static wait(duration: number): SingleEvent;
+    static wait(duration: number): IdleSingleEvent;
     static registerUpdateModifier(callback: (time: number, delta: number) => number): void;
     static cleanUpdateModifier(): void;
     static triggerUpdateTick(delta: number): void;
@@ -442,26 +440,25 @@ interface MenuOptions {
     readonly backgroundDarkeningRatio: number;
 }
 declare class MenuUI extends Container {
-    static isAnyMenuTransitioning: actions_lib.Notifier<boolean>;
-    static getIsAnyMenuTransitioning(this: typeof MenuUI): boolean;
-    readonly onCreate: actions_lib.SingleNotifier<void>;
-    readonly onOpen: actions_lib.SingleNotifier<void>;
-    readonly onClose: actions_lib.SingleNotifier<void>;
+    static isAnyMenuTransitioning: actions_lib.PersistentNotifier<boolean>;
+    readonly onCreate: actions_lib.PersistentSingleNotifier<void>;
+    readonly onOpen: actions_lib.PersistentSingleNotifier<void>;
+    readonly onClose: actions_lib.PersistentSingleNotifier<void>;
     constructor(windowSprite: string, partialOptions: Partial<MenuOptions>);
     getBoundingMask(): Sprite;
-    close(): SingleEvent;
+    close(): IdleSingleEvent;
 }
 
 interface MenuEntityOptions {
     readonly closeOnBackgroundClick: boolean;
 }
 declare class MenuEntity extends SingletonEntity {
-    static subscribeIsOpen(): Sequence<boolean>;
+    static subscribeIsOpen(): IdleSequence<boolean>;
     constructor(partialOptions: Partial<MenuEntityOptions>);
-    onCreate(): SingleEvent;
-    onOpen(): SingleEvent;
-    onClose(): SingleEvent;
-    close(): SingleEvent;
+    onCreate(): IdleSingleEvent;
+    onOpen(): IdleSingleEvent;
+    onClose(): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
 interface MenuViewOptions {
@@ -748,7 +745,7 @@ declare class Camera {
     constructor();
     setPosition(position: Vector): void;
     setTransition(options: FocusingOptions): void;
-    appear(on: boolean, type?: CameraAppearTransitionType): SingleEvent;
+    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
 }
 
 interface GameConfiguration {
@@ -777,11 +774,9 @@ declare class Game {
     readonly stage: Container;
     readonly renderer: Pixi.Renderer;
     readonly _screenSize: Variable<Vector>;
-    readonly screenSize: actions_lib.Notifier<Vector>;
-    getScreenSize(): Vector;
+    readonly screenSize: actions_lib.PersistentNotifier<Vector>;
     readonly _screenSizeCenter: Variable<Vector>;
-    readonly screenSizeCenter: actions_lib.Notifier<Vector>;
-    getScreenSizeCenter(): Vector;
+    readonly screenSizeCenter: actions_lib.PersistentNotifier<Vector>;
     readonly devMode: boolean;
     constructor(partialConfiguration?: Partial<GameConfiguration>);
     setup(setupOptions: GameSetupOptions): Promise<void>;
@@ -813,16 +808,11 @@ declare class KeyboardService {
 }
 
 declare class MouseService {
-    readonly onInitialMouseMove: actions_lib.Notifier<boolean>;
-    get initialMouseMoveHappened(): boolean;
-    readonly stagePosition: actions_lib.Notifier<Vector>;
-    getStagePosition(): Vector;
-    readonly screenPosition: actions_lib.Notifier<Vector>;
-    getScreenPosition(): Vector;
-    readonly mainButtonState: actions_lib.Notifier<boolean>;
-    getMainButtonState(): boolean;
-    readonly secondaryButtonState: actions_lib.Notifier<boolean>;
-    getSecondaryButtonState(): boolean;
+    readonly initialMouseMovementHappened: actions_lib.PersistentNotifier<boolean>;
+    readonly stagePosition: actions_lib.PersistentNotifier<Vector>;
+    readonly screenPosition: actions_lib.PersistentNotifier<Vector>;
+    readonly mainButtonState: actions_lib.PersistentNotifier<boolean>;
+    readonly secondaryButtonState: actions_lib.PersistentNotifier<boolean>;
     constructor();
     /**
      * Maps viewport (DOM) coordinates to Pixi logical screen space (`renderer.screen`),
@@ -846,7 +836,7 @@ declare const SPEED_LIMIT = 10.8;
 declare const ROTATIONAL_SPEED_LIMIT = 10.01;
 interface PhysicsBodyDTO {
     readonly entityID: number;
-    readonly classID: number;
+    readonly classID: ClassID;
     readonly position: Vector;
     readonly rotation: Radian;
     readonly velocity: Vector;
@@ -957,7 +947,7 @@ interface BorderProperties {
 
 type InteractingBodyGroups = readonly (readonly [PhysicsBodyGroup, PhysicsBodyGroup])[];
 interface CreatePhysicsWorldRequestDTO {
-    readonly attachTo: number;
+    readonly attachTo: AttachmentID;
     readonly mapSize: Vector;
     readonly modifyUpdateCycle: boolean;
     readonly borderProperties: BorderProperties;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as actions_lib from 'actions-lib';
-import { IDAttachable, Attachable, SingleEvent, Sequence, SingleNotifier, Notifier, Reducer, Variable, Action } from 'actions-lib';
+import { IDAttachable, Attachable, AttachmentID, IdleSingleEvent, IdleSequence, Sequence, SingleNotifier, Notifier, SingleEvent, Reducer, Variable, Action, ClassID } from 'actions-lib';
 import { Vector, Radian, Rectangle, Vec2, RGBColor, Grid, GridNeighborType, Line } from 'helpers-lib';
 import * as Pixi from 'pixi.js';
 
@@ -22,7 +22,7 @@ declare abstract class Entity extends IDAttachable {
     constructor();
     destroy(): void;
     attach(parent: Attachable): this;
-    attachByID(id: number): this;
+    attachByID(id: AttachmentID): this;
     attachToRoot(): this;
 }
 
@@ -30,8 +30,8 @@ type SingletonEntityClassType<T extends SingletonEntity = SingletonEntity> = (ne
     id: number;
 };
 declare abstract class SingletonEntity extends Entity {
-    static getInstanceAsync<T extends SingletonEntity>(this: SingletonEntityClassType<T>): SingleEvent<T>;
-    static continuesSubscription<T extends SingletonEntity>(this: SingletonEntityClassType<T>): Sequence<{
+    static getInstanceAsync<T extends SingletonEntity>(this: SingletonEntityClassType<T>): IdleSingleEvent<T>;
+    static continuesSubscription<T extends SingletonEntity>(this: SingletonEntityClassType<T>): IdleSequence<{
         type: 'open' | 'close';
         value: T;
     }>;
@@ -49,23 +49,21 @@ type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
 type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
 declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
 declare abstract class Scene<InputType, OutputType> extends IDAttachable {
-    static readonly isTransitioning: actions_lib.Notifier<boolean>;
-    static getIsTransitioning(this: typeof Scene): boolean;
-    static readonly activeScene: actions_lib.Notifier<Scene<unknown, unknown> | undefined>;
-    static getActiveScene(this: typeof Scene): Scene<unknown, unknown> | undefined;
+    static readonly isTransitioning: actions_lib.PersistentNotifier<boolean>;
+    static readonly activeScene: actions_lib.PersistentNotifier<Scene<unknown, unknown> | undefined>;
     static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
-    static cancelActiveScene(): SingleEvent;
+    static cancelActiveScene(): IdleSingleEvent;
     static isActive<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): boolean;
     static getInstance<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T | undefined;
     static getInstanceOrFail<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T;
-    static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): SingleEvent<T>;
-    readonly onClose: actions_lib.SingleNotifier<OutputType>;
+    static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
+    readonly onClose: actions_lib.PersistentSingleNotifier<OutputType>;
     constructor();
-    close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): SingleEvent<OutputType>;
+    close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): IdleSingleEvent<OutputType>;
     private animateAndClose;
-    protected abstract init(input: InputType): SingleEvent;
+    protected abstract init(input: InputType): IdleSingleEvent;
     protected abstract update(time: number, delta: number): void;
-    protected abstract prepareToClose(): SingleEvent;
+    protected abstract prepareToClose(): IdleSingleEvent;
     /**
      * @deprecated
      */
@@ -90,7 +88,7 @@ declare class UpdateCycle {
         time: number;
         delta: number;
     }>;
-    static wait(duration: number): SingleEvent;
+    static wait(duration: number): IdleSingleEvent;
     static registerUpdateModifier(callback: (time: number, delta: number) => number): void;
     static cleanUpdateModifier(): void;
     static triggerUpdateTick(delta: number): void;
@@ -442,26 +440,25 @@ interface MenuOptions {
     readonly backgroundDarkeningRatio: number;
 }
 declare class MenuUI extends Container {
-    static isAnyMenuTransitioning: actions_lib.Notifier<boolean>;
-    static getIsAnyMenuTransitioning(this: typeof MenuUI): boolean;
-    readonly onCreate: actions_lib.SingleNotifier<void>;
-    readonly onOpen: actions_lib.SingleNotifier<void>;
-    readonly onClose: actions_lib.SingleNotifier<void>;
+    static isAnyMenuTransitioning: actions_lib.PersistentNotifier<boolean>;
+    readonly onCreate: actions_lib.PersistentSingleNotifier<void>;
+    readonly onOpen: actions_lib.PersistentSingleNotifier<void>;
+    readonly onClose: actions_lib.PersistentSingleNotifier<void>;
     constructor(windowSprite: string, partialOptions: Partial<MenuOptions>);
     getBoundingMask(): Sprite;
-    close(): SingleEvent;
+    close(): IdleSingleEvent;
 }
 
 interface MenuEntityOptions {
     readonly closeOnBackgroundClick: boolean;
 }
 declare class MenuEntity extends SingletonEntity {
-    static subscribeIsOpen(): Sequence<boolean>;
+    static subscribeIsOpen(): IdleSequence<boolean>;
     constructor(partialOptions: Partial<MenuEntityOptions>);
-    onCreate(): SingleEvent;
-    onOpen(): SingleEvent;
-    onClose(): SingleEvent;
-    close(): SingleEvent;
+    onCreate(): IdleSingleEvent;
+    onOpen(): IdleSingleEvent;
+    onClose(): IdleSingleEvent;
+    close(): IdleSingleEvent;
 }
 
 interface MenuViewOptions {
@@ -748,7 +745,7 @@ declare class Camera {
     constructor();
     setPosition(position: Vector): void;
     setTransition(options: FocusingOptions): void;
-    appear(on: boolean, type?: CameraAppearTransitionType): SingleEvent;
+    appear(on: boolean, type?: CameraAppearTransitionType): IdleSingleEvent;
 }
 
 interface GameConfiguration {
@@ -777,11 +774,9 @@ declare class Game {
     readonly stage: Container;
     readonly renderer: Pixi.Renderer;
     readonly _screenSize: Variable<Vector>;
-    readonly screenSize: actions_lib.Notifier<Vector>;
-    getScreenSize(): Vector;
+    readonly screenSize: actions_lib.PersistentNotifier<Vector>;
     readonly _screenSizeCenter: Variable<Vector>;
-    readonly screenSizeCenter: actions_lib.Notifier<Vector>;
-    getScreenSizeCenter(): Vector;
+    readonly screenSizeCenter: actions_lib.PersistentNotifier<Vector>;
     readonly devMode: boolean;
     constructor(partialConfiguration?: Partial<GameConfiguration>);
     setup(setupOptions: GameSetupOptions): Promise<void>;
@@ -813,16 +808,11 @@ declare class KeyboardService {
 }
 
 declare class MouseService {
-    readonly onInitialMouseMove: actions_lib.Notifier<boolean>;
-    get initialMouseMoveHappened(): boolean;
-    readonly stagePosition: actions_lib.Notifier<Vector>;
-    getStagePosition(): Vector;
-    readonly screenPosition: actions_lib.Notifier<Vector>;
-    getScreenPosition(): Vector;
-    readonly mainButtonState: actions_lib.Notifier<boolean>;
-    getMainButtonState(): boolean;
-    readonly secondaryButtonState: actions_lib.Notifier<boolean>;
-    getSecondaryButtonState(): boolean;
+    readonly initialMouseMovementHappened: actions_lib.PersistentNotifier<boolean>;
+    readonly stagePosition: actions_lib.PersistentNotifier<Vector>;
+    readonly screenPosition: actions_lib.PersistentNotifier<Vector>;
+    readonly mainButtonState: actions_lib.PersistentNotifier<boolean>;
+    readonly secondaryButtonState: actions_lib.PersistentNotifier<boolean>;
     constructor();
     /**
      * Maps viewport (DOM) coordinates to Pixi logical screen space (`renderer.screen`),
@@ -846,7 +836,7 @@ declare const SPEED_LIMIT = 10.8;
 declare const ROTATIONAL_SPEED_LIMIT = 10.01;
 interface PhysicsBodyDTO {
     readonly entityID: number;
-    readonly classID: number;
+    readonly classID: ClassID;
     readonly position: Vector;
     readonly rotation: Radian;
     readonly velocity: Vector;
@@ -957,7 +947,7 @@ interface BorderProperties {
 
 type InteractingBodyGroups = readonly (readonly [PhysicsBodyGroup, PhysicsBodyGroup])[];
 interface CreatePhysicsWorldRequestDTO {
-    readonly attachTo: number;
+    readonly attachTo: AttachmentID;
     readonly mapSize: Vector;
     readonly modifyUpdateCycle: boolean;
     readonly borderProperties: BorderProperties;