bard-legends-framework 1.3.2 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as actions_lib from 'actions-lib';
2
2
  import { IDAttachable, Attachable, SingleEvent, Sequence, SingleNotifier, Notifier, Reducer, Variable, Action } from 'actions-lib';
3
- import { Vector, Radian, Rectangle, Vec2, RGBColor, TypeValuePair, Grid, GridNeighborType, Line } from 'helpers-lib';
3
+ import { Vector, Radian, Rectangle, Vec2, RGBColor, Grid, GridNeighborType, Line } from 'helpers-lib';
4
4
  import * as Pixi from 'pixi.js';
5
5
 
6
6
  declare class ControllerLink {
@@ -49,6 +49,8 @@ type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
49
49
  type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
50
50
  declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
51
51
  declare abstract class Scene<InputType, OutputType> extends IDAttachable {
52
+ static readonly isTransitioning: actions_lib.Notifier<boolean>;
53
+ static getIsTransitioning(this: typeof Scene): boolean;
52
54
  static readonly activeScene: actions_lib.Notifier<Scene<unknown, unknown> | undefined>;
53
55
  static getActiveScene(this: typeof Scene): Scene<unknown, unknown> | undefined;
54
56
  static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
@@ -426,48 +428,42 @@ declare class DisplayObjectArray<T> extends Container {
426
428
  set(items: readonly T[]): void;
427
429
  }
428
430
 
429
- type MenuUINewMenuOpenBehavior = 'close' | 'temporarilyDisappear' | 'stayInBackground';
430
- type MenuCloseReason<OutputType = undefined> = TypeValuePair<{
431
- backgroundClick: undefined;
432
- newMenuOpened: undefined;
433
- withValue: OutputType;
434
- }>;
435
431
  interface MenuOptions {
436
- readonly onNewMenuOpen: MenuUINewMenuOpenBehavior;
437
432
  readonly closeOnBackgroundClick: boolean;
438
433
  readonly appearAnimationDuration: number;
439
434
  readonly backgroundDarkeningRatio: number;
440
435
  }
441
- declare class MenuUI<OutputType = undefined> extends Container {
436
+ declare class MenuUI extends Container {
437
+ static isAnyMenuTransitioning: actions_lib.Notifier<boolean>;
438
+ static getIsAnyMenuTransitioning(this: typeof MenuUI): boolean;
442
439
  readonly onCreate: actions_lib.SingleNotifier<void>;
443
440
  readonly onOpen: actions_lib.SingleNotifier<void>;
444
- readonly onClose: actions_lib.SingleNotifier<MenuCloseReason<OutputType>>;
441
+ readonly onClose: actions_lib.SingleNotifier<void>;
445
442
  constructor(windowSprite: string, partialOptions: Partial<MenuOptions>);
446
443
  getBoundingMask(): Sprite;
447
- close(output: MenuCloseReason<OutputType>): SingleEvent<MenuCloseReason<OutputType>>;
444
+ close(): SingleEvent;
448
445
  }
449
446
 
450
447
  interface MenuEntityOptions {
451
- readonly onNewMenuOpen: MenuUINewMenuOpenBehavior;
452
448
  readonly closeOnBackgroundClick: boolean;
453
449
  }
454
- declare class MenuEntity<OutputType = undefined> extends SingletonEntity {
450
+ declare class MenuEntity extends SingletonEntity {
455
451
  constructor(partialOptions: Partial<MenuEntityOptions>);
456
452
  onCreate(): SingleEvent;
457
453
  onOpen(): SingleEvent;
458
- onClose(): SingleEvent<MenuCloseReason<OutputType>>;
459
- close(...args: undefined extends OutputType ? (OutputType extends undefined ? [] : [OutputType]) : [OutputType]): SingleEvent<MenuCloseReason<OutputType>>;
454
+ onClose(): SingleEvent;
455
+ close(): SingleEvent;
460
456
  }
461
457
 
462
458
  interface MenuViewOptions {
463
459
  readonly appearAnimationDuration: number;
464
460
  readonly backgroundDarkeningRatio: number;
465
461
  }
466
- declare class MenuView<OutputType = void> extends View {
462
+ declare class MenuView extends View {
467
463
  readonly onCreate: SingleNotifier<Container>;
468
464
  readonly onOpen: SingleNotifier;
469
- readonly onClose: SingleNotifier<MenuCloseReason<OutputType>>;
470
- constructor(entity: MenuEntity<OutputType>, windowSprite: string, partialOptions: Partial<MenuViewOptions>);
465
+ readonly onClose: SingleNotifier;
466
+ constructor(entity: MenuEntity, windowSprite: string, partialOptions: Partial<MenuViewOptions>);
471
467
  }
472
468
 
473
469
  interface ScrollAreaUIOptions {
@@ -997,4 +993,4 @@ declare class PhysicsGateway {
997
993
  printPathfindingTestGrid(physicsWorldID: number, testLayerID: number, target: Vector | number, physicsBodyGroup: PhysicsBodyGroup, area: Rectangle, gridCellSize?: number): void;
998
994
  }
999
995
 
1000
- 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 ControllerDecoratorMeta, ControllerLink, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, type MenuCloseReason, MenuEntity, type MenuOptions, MenuUI, type MenuUINewMenuOpenBehavior, 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 };
996
+ 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 ControllerDecoratorMeta, ControllerLink, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, 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 };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as actions_lib from 'actions-lib';
2
2
  import { IDAttachable, Attachable, SingleEvent, Sequence, SingleNotifier, Notifier, Reducer, Variable, Action } from 'actions-lib';
3
- import { Vector, Radian, Rectangle, Vec2, RGBColor, TypeValuePair, Grid, GridNeighborType, Line } from 'helpers-lib';
3
+ import { Vector, Radian, Rectangle, Vec2, RGBColor, Grid, GridNeighborType, Line } from 'helpers-lib';
4
4
  import * as Pixi from 'pixi.js';
5
5
 
6
6
  declare class ControllerLink {
@@ -49,6 +49,8 @@ type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
49
49
  type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
50
50
  declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
51
51
  declare abstract class Scene<InputType, OutputType> extends IDAttachable {
52
+ static readonly isTransitioning: actions_lib.Notifier<boolean>;
53
+ static getIsTransitioning(this: typeof Scene): boolean;
52
54
  static readonly activeScene: actions_lib.Notifier<Scene<unknown, unknown> | undefined>;
53
55
  static getActiveScene(this: typeof Scene): Scene<unknown, unknown> | undefined;
54
56
  static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
@@ -426,48 +428,42 @@ declare class DisplayObjectArray<T> extends Container {
426
428
  set(items: readonly T[]): void;
427
429
  }
428
430
 
429
- type MenuUINewMenuOpenBehavior = 'close' | 'temporarilyDisappear' | 'stayInBackground';
430
- type MenuCloseReason<OutputType = undefined> = TypeValuePair<{
431
- backgroundClick: undefined;
432
- newMenuOpened: undefined;
433
- withValue: OutputType;
434
- }>;
435
431
  interface MenuOptions {
436
- readonly onNewMenuOpen: MenuUINewMenuOpenBehavior;
437
432
  readonly closeOnBackgroundClick: boolean;
438
433
  readonly appearAnimationDuration: number;
439
434
  readonly backgroundDarkeningRatio: number;
440
435
  }
441
- declare class MenuUI<OutputType = undefined> extends Container {
436
+ declare class MenuUI extends Container {
437
+ static isAnyMenuTransitioning: actions_lib.Notifier<boolean>;
438
+ static getIsAnyMenuTransitioning(this: typeof MenuUI): boolean;
442
439
  readonly onCreate: actions_lib.SingleNotifier<void>;
443
440
  readonly onOpen: actions_lib.SingleNotifier<void>;
444
- readonly onClose: actions_lib.SingleNotifier<MenuCloseReason<OutputType>>;
441
+ readonly onClose: actions_lib.SingleNotifier<void>;
445
442
  constructor(windowSprite: string, partialOptions: Partial<MenuOptions>);
446
443
  getBoundingMask(): Sprite;
447
- close(output: MenuCloseReason<OutputType>): SingleEvent<MenuCloseReason<OutputType>>;
444
+ close(): SingleEvent;
448
445
  }
449
446
 
450
447
  interface MenuEntityOptions {
451
- readonly onNewMenuOpen: MenuUINewMenuOpenBehavior;
452
448
  readonly closeOnBackgroundClick: boolean;
453
449
  }
454
- declare class MenuEntity<OutputType = undefined> extends SingletonEntity {
450
+ declare class MenuEntity extends SingletonEntity {
455
451
  constructor(partialOptions: Partial<MenuEntityOptions>);
456
452
  onCreate(): SingleEvent;
457
453
  onOpen(): SingleEvent;
458
- onClose(): SingleEvent<MenuCloseReason<OutputType>>;
459
- close(...args: undefined extends OutputType ? (OutputType extends undefined ? [] : [OutputType]) : [OutputType]): SingleEvent<MenuCloseReason<OutputType>>;
454
+ onClose(): SingleEvent;
455
+ close(): SingleEvent;
460
456
  }
461
457
 
462
458
  interface MenuViewOptions {
463
459
  readonly appearAnimationDuration: number;
464
460
  readonly backgroundDarkeningRatio: number;
465
461
  }
466
- declare class MenuView<OutputType = void> extends View {
462
+ declare class MenuView extends View {
467
463
  readonly onCreate: SingleNotifier<Container>;
468
464
  readonly onOpen: SingleNotifier;
469
- readonly onClose: SingleNotifier<MenuCloseReason<OutputType>>;
470
- constructor(entity: MenuEntity<OutputType>, windowSprite: string, partialOptions: Partial<MenuViewOptions>);
465
+ readonly onClose: SingleNotifier;
466
+ constructor(entity: MenuEntity, windowSprite: string, partialOptions: Partial<MenuViewOptions>);
471
467
  }
472
468
 
473
469
  interface ScrollAreaUIOptions {
@@ -997,4 +993,4 @@ declare class PhysicsGateway {
997
993
  printPathfindingTestGrid(physicsWorldID: number, testLayerID: number, target: Vector | number, physicsBodyGroup: PhysicsBodyGroup, area: Rectangle, gridCellSize?: number): void;
998
994
  }
999
995
 
1000
- 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 ControllerDecoratorMeta, ControllerLink, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, KeyboardService, type MapSizeDTO, type MaterialContactDefinition, type MaterialDefinition, type MenuCloseReason, MenuEntity, type MenuOptions, MenuUI, type MenuUINewMenuOpenBehavior, 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 };
996
+ 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 ControllerDecoratorMeta, ControllerLink, type CreateDashedLineOptions, type CreatePhysicsWorldRequestDTO, Cursor, DEFAULT_SHADER_RESOLUTION, DeltaTime, DisplayObjectArray, type DisplayObjectArrayOptions, type DropShadowOptions, Entity, EntityDecorator, type ExplosionHit, FadeInContent, type FadeInContentOptions, FadeInStateAnimation, FocusingAnimation, Game, type GlowEffectOptions, type GlowOptions, type GlowingShapeDefinition, Graphics, type HitTestOptions, ImmovablePhysicsEntity, type InteractingBodyGroups, 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 };