angry-pixel 2.1.4 → 2.1.5

package/lib/index.d.ts

@@ -957,13 +957,18 @@ declare class EntityManager {
     removeEntity(entity: Entity): void;
     /**
      * Removes all Entities and all their Components
+     * @param preserveComponentType Optional component type to preserve entities that have this component
      * @public
      * @example
      * ```js
+     * // Remove all entities
      * entityManager.removeAllEntities();
+     *
+     * // Remove all entities except those that have a SpriteRenderer component
+     * entityManager.removeAllEntities(SpriteRenderer);
      * ```
      */
-    removeAllEntities(): void;
+    removeAllEntities(preserveComponentType?: ComponentType): void;
     /**
      * If the Entity exists, returns TRUE, otherwise it returns FALSE
      * @param entity
@@ -1277,7 +1282,7 @@ declare class EntityManager {
      * The third argument determines if disabled entities or components are included in the search result,\its default value is FALSE.
      * @param componentType The component class
      * @param filter The filter function
-     * @param includeDisabled TRUE to incluide disabled entities and components, FALSE otherwise
+     * @param includeDisabled TRUE to incluide disabled entities and components. Default is FALSE.
      * @returns SearchResult
      * @public
      * @example
@@ -1309,7 +1314,7 @@ declare class EntityManager {
      * This method returns a collection of objects of type SearchResult, which has the entity found, and the instance of the component.\
      * The second argument determines if disabled entities or components are included in the search result,\its default value is FALSE.
      * @param componentType The component class
-     * @param includeDisabled TRUE to incluide disabled entities and components, FALSE otherwise
+     * @param includeDisabled TRUE to incluide disabled entities and components. Default is FALSE.
      * @returns SearchResult
      * @public
      * @example
@@ -1348,7 +1353,7 @@ declare class EntityManager {
      * The third argument determines if disabled entities or components are included in the search result,\its default value is FALSE.
      * @param parent The parent entity
      * @param componentType The component class
-     * @param includeDisabled TRUE to incluide disabled entities and components, FALSE otherwise
+     * @param includeDisabled TRUE to incluide disabled entities and components. Default is FALSE.
      * @returns SearchResult
      * @public
      * @example
@@ -1942,6 +1947,66 @@ declare class TimeManager {
     clearAllIntervals(): void;
 }
 
+/**
+ * Manages scene loading, transitions and lifecycle.\
+ * Provides methods to register scenes, load scenes by name, and handles the opening scene.\
+ * Ensures proper cleanup between scene transitions and maintains scene state.
+ * @public
+ * @category Managers
+ * @example
+ * ```js
+ * this.sceneManager.loadScene("MainScene");
+ * ```
+ */
+declare class SceneManager {
+    private readonly systemManager;
+    private readonly systemFactory;
+    private readonly entityManager;
+    private readonly assetManager;
+    private readonly timeManager;
+    private readonly scenes;
+    private openingSceneName;
+    private currentSceneName;
+    private sceneNameToBeLoaded;
+    private _loadingScene;
+    private _sceneLoadedThisFrame;
+    private preserveEntitiesWithComponent;
+    /** @internal */
+    constructor(systemManager: SystemManager, systemFactory: CreateSystemService, entityManager: EntityManager, assetManager: AssetManager, timeManager: TimeManager);
+    /**
+     * Adds a scene to the SceneManager
+     * @param sceneType The scene class
+     * @param name The name of the scene
+     * @param openingScene Whether the scene is the opening scene
+     * @public
+     */
+    addScene(sceneType: SceneType, name: string, openingScene?: boolean): void;
+    /**
+     * Loads a scene
+     * @param name The name of the scene
+     * @param preserveEntitiesWithComponent Optional component type to preserve entities that have this component
+     * @public
+     */
+    loadScene(name: string, preserveEntitiesWithComponent?: ComponentType): void;
+    /**
+     * Loads the opening scene
+     * @public
+     */
+    loadOpeningScene(): void;
+    /**
+     * Returns true if the scene is loading
+     * @public
+     */
+    get loadingScene(): boolean;
+    /**
+     * Returns true if the scene was loaded this frame
+     * @public
+     */
+    get sceneLoadedThisFrame(): boolean;
+    /** @internal */
+    update(): void;
+    private destroyCurrentScene;
+}
 /**
  * This type represents a scene class
  * @public
@@ -1965,14 +2030,14 @@ type SceneType<T extends Scene = Scene> = {
  *      this.assetManager.loadImage("image.png");
  *   }
  *
- *   loadSystems() {
+ *   registerSystems() {
  *     this.systems.push(
  *         SomeSystem,
  *         AnotherSystem
  *     );
  *   }
  *
- *   setup() {
+ *   createEntities() {
  *     this.entityManager.createEntity([
  *       SomeComponent,
  *       AnotherComponent
@@ -1986,43 +2051,33 @@ declare abstract class Scene {
     protected readonly assetManager: AssetManager;
     systems: SystemType[];
     constructor(entityManager: EntityManager, assetManager: AssetManager);
-    loadSystems(): void;
+    /**
+     * Override this method to register the systems that will be executed in the scene
+     * @public
+     */
+    registerSystems(): void;
+    /**
+     * Override this method to load the assets needed for the scene
+     * @public
+     */
     loadAssets(): void;
-    setup(): void;
-}
-/**
- * Manages scene loading, transitions and lifecycle.\
- * Provides methods to register scenes, load scenes by name, and handles the opening scene.\
- * Ensures proper cleanup between scene transitions and maintains scene state.
- * @public
- * @category Managers
- * @example
- * ```js
- * this.sceneManager.loadScene("MainScene");
- * ```
- */
-declare class SceneManager {
-    private readonly systemManager;
-    private readonly systemFactory;
-    private readonly entityManager;
-    private readonly assetManager;
-    private readonly timeManager;
-    private readonly scenes;
-    private openingSceneName;
-    private currentSceneName;
-    private sceneNameToBeLoaded;
-    private _loadingScene;
-    private _sceneLoadedThisFrame;
-    /** @internal */
-    constructor(systemManager: SystemManager, systemFactory: CreateSystemService, entityManager: EntityManager, assetManager: AssetManager, timeManager: TimeManager);
-    addScene(sceneType: SceneType, name: string, openingScene?: boolean): void;
-    loadScene(name: string): void;
-    loadOpeningScene(): void;
-    get loadingScene(): boolean;
-    get sceneLoadedThisFrame(): boolean;
-    /** @internal */
-    update(): void;
-    private destroyCurrentScene;
+    /**
+     * Override this method to create the entities needed for the scene
+     * @public
+     */
+    createEntities(): void;
+    /**
+     * Adds a system to the scene
+     * @param system The system to add
+     * @public
+     */
+    protected addSystem(system: SystemType): void;
+    /**
+     * Adds multiple systems to the scene
+     * @param systems The systems to add
+     * @public
+     */
+    protected addSystems(systems: SystemType[]): void;
 }
 
 /**
@@ -2116,6 +2171,7 @@ declare class Game {
  * const walkAnimation = new Animation({
  *   image: "walk.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [0, 1, 2, 3, 4, 5],
  *   fps: 12,
  *   loop: true
  * });
@@ -2123,6 +2179,7 @@ declare class Game {
  * const idleAnimation = new Animation({
  *   image: "idle.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [6, 7, 8, 9]
  *   fps: 8,
  *   loop: true
  * });
@@ -2154,6 +2211,7 @@ interface AnimatorOptions {
  * const walkAnimation = new Animation({
  *   image: "walk.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [0, 1, 2, 3, 4, 5],
  *   fps: 12,
  *   loop: true
  * });
@@ -2161,6 +2219,7 @@ interface AnimatorOptions {
  * const idleAnimation = new Animation({
  *   image: "idle.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [6, 7, 8, 9],
  *   fps: 8,
  *   loop: true
  * });
@@ -2199,6 +2258,7 @@ declare class Animator {
  * const walkAnimation = new Animation({
  *   image: "walk.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [0, 1, 2, 3, 4, 5],
  *   fps: 12,
  *   loop: true
  * });
@@ -2206,6 +2266,7 @@ declare class Animator {
  * const idleAnimation = new Animation({
  *   image: "idle.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [6, 7, 8, 9],
  *   fps: 8,
  *   loop: true
  * });
@@ -2242,6 +2303,7 @@ interface AnimationOptions {
  * const walkAnimation = new Animation({
  *   image: "walk.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [0, 1, 2, 3, 4, 5],
  *   fps: 12,
  *   loop: true
  * });
@@ -2249,6 +2311,7 @@ interface AnimationOptions {
  * const idleAnimation = new Animation({
  *   image: "idle.png",
  *   slice: { size: new Vector2(32, 32) },
+ *   frames: [6, 7, 8, 9],
  *   fps: 8,
  *   loop: true
  * });
@@ -2301,6 +2364,8 @@ interface AudioPlayerOptions {
     action: AudioPlayerAction;
     /** The audio source to play. */
     audioSource: HTMLAudioElement | string;
+    /** TRUE If the audio source should stop on scene transition, FALSE otherwise. Default is TRUE. */
+    stopOnSceneTransition: boolean;
     /** TRUE If the playback rate is fixed to the TimeManager time scale, default FALSE */
     fixedToTimeScale: boolean;
     /** TRUE If the audio source should loop. */
@@ -2328,6 +2393,8 @@ declare class AudioPlayer {
     action: AudioPlayerAction;
     /** The audio source to play. */
     audioSource: HTMLAudioElement | string;
+    /** TRUE If the audio source should stop on scene transition, FALSE otherwise. Default is TRUE. */
+    stopOnSceneTransition: boolean;
     /** TRUE If the playback rate is fixed to the TimeManager time scale, default FALSE */
     fixedToTimeScale: boolean;
     /** TRUE If the audio source should loop. */