bard-legends-framework 1.7.2 → 1.8.1

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
@@ -81,7 +81,7 @@ declare class BardLegendsHardReset {
81
81
  static hardReset(): void;
82
82
  }
83
83
 
84
- type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
84
+ type SceneClassType = new (...services: any[]) => Scene<any, any>;
85
85
  type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
86
86
  declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
87
87
  declare abstract class Scene<InputType, OutputType> extends IDAttachable {
@@ -89,16 +89,16 @@ declare abstract class Scene<InputType, OutputType> extends IDAttachable {
89
89
  static readonly activeScene: actions_lib.PersistentNotifier<Scene<unknown, unknown> | undefined>;
90
90
  static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
91
91
  static cancelActiveScene(): IdleSingleEvent;
92
- static isActive<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): boolean;
93
- static getInstance<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T | undefined;
94
- static getInstanceOrFail<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T;
95
- static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
92
+ static isActive<T extends Scene<any, any>>(this: new (...args: any[]) => T): boolean;
93
+ static getInstance<T extends Scene<any, any>>(this: new (...args: any[]) => T): T | undefined;
94
+ static getInstanceOrFail<T extends Scene<any, any>>(this: new (...args: any[]) => T): T;
95
+ static open<T extends Scene<any, any>>(this: new (...args1: any[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
96
96
  readonly onClose: actions_lib.PersistentSingleNotifier<OutputType>;
97
97
  constructor();
98
98
  close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): IdleSingleEvent<OutputType>;
99
- protected abstract init(input: InputType): IdleSingleEvent;
100
- protected abstract update(time: number, delta: number): void;
101
- protected abstract prepareToClose(): IdleSingleEvent;
99
+ protected abstract init: (input: InputType) => IdleSingleEvent;
100
+ protected abstract update: (time: number, delta: number) => void;
101
+ protected abstract prepareToClose: (output: OutputType | 'cancel') => IdleSingleEvent;
102
102
  /**
103
103
  * @deprecated
104
104
  */
@@ -140,7 +140,7 @@ declare abstract class View extends IDAttachable {
140
140
  static getInstanceOrFail<T extends View>(this: new (...args: any[]) => T, entityID: number): T;
141
141
  constructor();
142
142
  destroy(): void;
143
- update(time: number, delta: number): void;
143
+ update: (time: number, delta: number) => void;
144
144
  }
145
145
 
146
146
  type AudioAppearTransitionType = 'ease' | 'instant';
@@ -317,7 +317,8 @@ declare class Game {
317
317
  }
318
318
 
319
319
  interface SoundOptions {
320
- readonly offset?: number;
320
+ readonly time?: number;
321
+ readonly volume?: number;
321
322
  }
322
323
  declare class Sound extends IDAttachable {
323
324
  static createByName(soundName: SoundID, options?: SoundOptions): Sound;
@@ -331,7 +332,7 @@ declare class Sound extends IDAttachable {
331
332
  setVolume(value: number): this;
332
333
  constructor(soundDefinition: SoundDefinition, options?: SoundOptions);
333
334
  destroy(): void;
334
- protected _play(offset: number): void;
335
+ protected _play(time: number): void;
335
336
  protected _stop(): void;
336
337
  }
337
338
 
@@ -361,6 +362,10 @@ interface MusicOptions extends SoundOptions {
361
362
  }
362
363
  declare class Music extends IDAttachable {
363
364
  static createByName(soundName: SoundID, options?: MusicOptions): Music;
365
+ get time(): number;
366
+ get volume(): number;
367
+ set volume(volume: number);
368
+ setVolume(volume: number): this;
364
369
  constructor(soundDefinition: SoundDefinition, partialOptions?: Partial<MusicOptions>);
365
370
  /**
366
371
  * Note: If then music time should stay synced with the game time, "stopPlayingOnPause" option has to be set true.
@@ -374,13 +379,19 @@ declare class Music extends IDAttachable {
374
379
  interface MusicPlayerOptionsNoPause extends MusicOptions {
375
380
  readonly stopPlayingOnPause: false;
376
381
  readonly playWhenPaused: undefined;
382
+ readonly volume: number;
377
383
  }
378
384
  interface MusicPlayerOptionsWithPause extends MusicOptions {
379
385
  readonly stopPlayingOnPause: true;
380
386
  readonly playWhenPaused: SoundID | undefined;
387
+ readonly volume: number;
381
388
  }
382
389
  type MusicPlayerOptions = MusicPlayerOptionsNoPause | MusicPlayerOptionsWithPause;
383
390
  declare class MusicPlayer extends IDAttachable {
391
+ get time(): number;
392
+ get volume(): number;
393
+ set volume(volume: number);
394
+ setVolume(volume: number): this;
384
395
  constructor(partialOptions?: Partial<MusicPlayerOptions>);
385
396
  play(soundID: SoundID): IdleSingleEvent<Music | undefined>;
386
397
  stop(): IdleSingleEvent;
package/dist/index.d.ts CHANGED
@@ -81,7 +81,7 @@ declare class BardLegendsHardReset {
81
81
  static hardReset(): void;
82
82
  }
83
83
 
84
- type SceneClassType = new (...services: unknown[]) => Scene<unknown, unknown>;
84
+ type SceneClassType = new (...services: any[]) => Scene<any, any>;
85
85
  type SceneInput<T> = T extends Scene<infer I, any> ? I : never;
86
86
  declare function SceneDecorator(): (SceneClass: SceneClassType) => any;
87
87
  declare abstract class Scene<InputType, OutputType> extends IDAttachable {
@@ -89,16 +89,16 @@ declare abstract class Scene<InputType, OutputType> extends IDAttachable {
89
89
  static readonly activeScene: actions_lib.PersistentNotifier<Scene<unknown, unknown> | undefined>;
90
90
  static getActiveSceneOrFail(this: typeof Scene): Scene<unknown, unknown>;
91
91
  static cancelActiveScene(): IdleSingleEvent;
92
- static isActive<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): boolean;
93
- static getInstance<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T | undefined;
94
- static getInstanceOrFail<T extends Scene<unknown, unknown>>(this: new (...args: unknown[]) => T): T;
95
- static open<T extends Scene<any, any>>(this: new (...args1: unknown[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
92
+ static isActive<T extends Scene<any, any>>(this: new (...args: any[]) => T): boolean;
93
+ static getInstance<T extends Scene<any, any>>(this: new (...args: any[]) => T): T | undefined;
94
+ static getInstanceOrFail<T extends Scene<any, any>>(this: new (...args: any[]) => T): T;
95
+ static open<T extends Scene<any, any>>(this: new (...args1: any[]) => T, ...args2: T extends Scene<void, any> ? [] : [SceneInput<T>]): IdleSingleEvent<T>;
96
96
  readonly onClose: actions_lib.PersistentSingleNotifier<OutputType>;
97
97
  constructor();
98
98
  close(...args: void extends OutputType ? (OutputType extends void ? [] : [OutputType]) : [OutputType]): IdleSingleEvent<OutputType>;
99
- protected abstract init(input: InputType): IdleSingleEvent;
100
- protected abstract update(time: number, delta: number): void;
101
- protected abstract prepareToClose(): IdleSingleEvent;
99
+ protected abstract init: (input: InputType) => IdleSingleEvent;
100
+ protected abstract update: (time: number, delta: number) => void;
101
+ protected abstract prepareToClose: (output: OutputType | 'cancel') => IdleSingleEvent;
102
102
  /**
103
103
  * @deprecated
104
104
  */
@@ -140,7 +140,7 @@ declare abstract class View extends IDAttachable {
140
140
  static getInstanceOrFail<T extends View>(this: new (...args: any[]) => T, entityID: number): T;
141
141
  constructor();
142
142
  destroy(): void;
143
- update(time: number, delta: number): void;
143
+ update: (time: number, delta: number) => void;
144
144
  }
145
145
 
146
146
  type AudioAppearTransitionType = 'ease' | 'instant';
@@ -317,7 +317,8 @@ declare class Game {
317
317
  }
318
318
 
319
319
  interface SoundOptions {
320
- readonly offset?: number;
320
+ readonly time?: number;
321
+ readonly volume?: number;
321
322
  }
322
323
  declare class Sound extends IDAttachable {
323
324
  static createByName(soundName: SoundID, options?: SoundOptions): Sound;
@@ -331,7 +332,7 @@ declare class Sound extends IDAttachable {
331
332
  setVolume(value: number): this;
332
333
  constructor(soundDefinition: SoundDefinition, options?: SoundOptions);
333
334
  destroy(): void;
334
- protected _play(offset: number): void;
335
+ protected _play(time: number): void;
335
336
  protected _stop(): void;
336
337
  }
337
338
 
@@ -361,6 +362,10 @@ interface MusicOptions extends SoundOptions {
361
362
  }
362
363
  declare class Music extends IDAttachable {
363
364
  static createByName(soundName: SoundID, options?: MusicOptions): Music;
365
+ get time(): number;
366
+ get volume(): number;
367
+ set volume(volume: number);
368
+ setVolume(volume: number): this;
364
369
  constructor(soundDefinition: SoundDefinition, partialOptions?: Partial<MusicOptions>);
365
370
  /**
366
371
  * Note: If then music time should stay synced with the game time, "stopPlayingOnPause" option has to be set true.
@@ -374,13 +379,19 @@ declare class Music extends IDAttachable {
374
379
  interface MusicPlayerOptionsNoPause extends MusicOptions {
375
380
  readonly stopPlayingOnPause: false;
376
381
  readonly playWhenPaused: undefined;
382
+ readonly volume: number;
377
383
  }
378
384
  interface MusicPlayerOptionsWithPause extends MusicOptions {
379
385
  readonly stopPlayingOnPause: true;
380
386
  readonly playWhenPaused: SoundID | undefined;
387
+ readonly volume: number;
381
388
  }
382
389
  type MusicPlayerOptions = MusicPlayerOptionsNoPause | MusicPlayerOptionsWithPause;
383
390
  declare class MusicPlayer extends IDAttachable {
391
+ get time(): number;
392
+ get volume(): number;
393
+ set volume(volume: number);
394
+ setVolume(volume: number): this;
384
395
  constructor(partialOptions?: Partial<MusicPlayerOptions>);
385
396
  play(soundID: SoundID): IdleSingleEvent<Music | undefined>;
386
397
  stop(): IdleSingleEvent;