@galacean/engine-core 1.1.0-beta.2 → 1.1.0-beta.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.1.0-beta.2",
+  "version": "1.1.0-beta.21",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.1.0-beta.2"
+    "@galacean/engine-math": "1.1.0-beta.21"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.1.0-beta.2"
+    "@galacean/engine-design": "1.1.0-beta.21"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/atlas/types.d.ts

@@ -1,3 +1,4 @@
+import { AssetType } from "../../asset/AssetType";
 import { TextureFilterMode, TextureFormat, TextureWrapMode } from "../../texture";
 /**
  * The original data type of the atlas.
@@ -16,6 +17,8 @@ export interface AtlasConfig {
     atlasItems: {
         /** The url of the sub atlas. */
         img: string;
+        /** Image type. */
+        type: AssetType;
         /** Sprites contained in the sub atlas. */
         sprites: AtlasSprite[];
     }[];

package/types/2d/enums/SpriteModifyFlags.d.ts

@@ -9,5 +9,6 @@ export declare enum SpriteModifyFlags {
     atlasRegionOffset = 16,
     region = 32,
     pivot = 64,
-    border = 128
+    border = 128,
+    destroy = 256
 }

package/types/Background.d.ts

@@ -33,11 +33,19 @@ export declare class Background {
      */
     get texture(): Texture2D;
     set texture(value: Texture2D);
+    /**
+     * Background texture fill mode.
+     * @remarks When `mode` is `BackgroundMode.Texture`, the property will take effects.
+     * @defaultValue `BackgroundTextureFillMode.FitHeight`
+     */
+    get textureFillMode(): BackgroundTextureFillMode;
     set textureFillMode(value: BackgroundTextureFillMode);
     /**
      * Constructor of Background.
      * @param _engine Engine Which the background belongs to.
      */
     constructor(_engine: Engine);
+    private _initMesh;
+    private _initMaterial;
     private _createPlane;
 }

package/types/Component.d.ts

@@ -5,8 +5,8 @@ import { Scene } from "./Scene";
  * The base class of the components.
  */
 export declare class Component extends EngineObject {
+    protected _phasedActiveInScene: boolean;
     private _phasedActive;
-    private _phasedActiveInScene;
     private _enabled;
     /**
      * Indicates whether the component is enabled.

package/types/DisorderedArray.d.ts

@@ -17,7 +17,7 @@ export declare class DisorderedArray<T> {
      * @returns The replaced item is used to reset its index
      */
     deleteByIndex(index: number): T;
-    forEach(callbackFn: (e: T) => void): void;
+    forEach(callbackFn: (element: T) => void, swapFn: (element: T, index: number) => void): void;
     forEachAndClean(callbackFn: (e: T) => void): void;
     garbageCollection(): void;
     private _startLoop;

package/types/RenderPipeline/MeshRenderElement.d.ts

@@ -4,14 +4,16 @@ import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader/ShaderPass";
 import { RenderState } from "../shader/state/RenderState";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
 /**
  * Render element.
  */
-export declare class MeshRenderElement extends RenderElement {
+export declare class MeshRenderElement extends RenderElement implements IPoolElement {
     /** Mesh. */
     mesh: Mesh;
     /** Sub mesh. */
     subMesh: SubMesh;
     setValue(component: Renderer, mesh: Mesh, subMesh: SubMesh, material: Material, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteElement.d.ts

@@ -4,10 +4,12 @@ import { Renderer } from "../Renderer";
 import { ShaderPass } from "../shader";
 import { RenderState } from "../shader/state/RenderState";
 import { Texture2D } from "../texture";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
-export declare class SpriteElement extends RenderElement {
+export declare class SpriteElement extends RenderElement implements IPoolElement {
     renderData: RenderData2D;
     texture: Texture2D;
     constructor();
     setValue(component: Renderer, renderDate: RenderData2D, material: Material, texture: Texture2D, renderState: RenderState, shaderPass: ShaderPass): void;
+    dispose(): void;
 }

package/types/RenderPipeline/SpriteMaskElement.d.ts

@@ -1,10 +1,12 @@
 import { RenderData2D } from "../2d/data/RenderData2D";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
-export declare class SpriteMaskElement extends RenderElement {
+export declare class SpriteMaskElement extends RenderElement implements IPoolElement {
     renderData: RenderData2D;
     isAdd: boolean;
     constructor();
     setValue(component: Renderer, renderData: RenderData2D, material: Material): void;
+    dispose(): void;
 }

package/types/RenderPipeline/TextRenderElement.d.ts

@@ -1,6 +1,8 @@
+import { IPoolElement } from "./IPoolElement";
 import { RenderElement } from "./RenderElement";
 import { SpriteElement } from "./SpriteElement";
-export declare class TextRenderElement extends RenderElement {
+export declare class TextRenderElement extends RenderElement implements IPoolElement {
     charElements: SpriteElement[];
     constructor();
+    dispose(): void;
 }

package/types/Scene.d.ts

@@ -41,6 +41,12 @@ export declare class Scene extends EngineObject {
     private _fogEnd;
     private _fogDensity;
     private _fogParams;
+    private _isActive;
+    /**
+     * Whether the scene is active.
+     */
+    get isActive(): boolean;
+    set isActive(value: boolean);
     /**
      * Scene-related shader data.
      */

package/types/asset/AssetPromise.d.ts

@@ -13,6 +13,7 @@ export declare class AssetPromise<T> implements PromiseLike<T> {
     get [Symbol.toStringTag](): string;
     private _promise;
     private _state;
+    private _progress;
     private _onProgressCallback;
     private _onCancelHandler;
     private _reject;

package/types/asset/ResourceManager.d.ts

@@ -104,7 +104,6 @@ export declare class ResourceManager {
     private _gc;
     private _getResolveResource;
     private _parseURL;
-    private _getParameterByName;
     private _parseQueryPath;
 }
 /**

package/types/enums/DepthMode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Depth texture mode.
+ */
+export declare enum DepthTextureMode {
+    None = 0,
+    PrePass = 1,
+    CopyAfterOpaque = 2
+}

package/types/lighting/DirectLight.d.ts

@@ -7,7 +7,6 @@ export declare class DirectLight extends Light {
     private static _cullingMaskProperty;
     private static _colorProperty;
     private static _directionProperty;
-    private static _combinedData;
     private _reverseDirection;
     /**
      * Get direction.
@@ -18,3 +17,11 @@ export declare class DirectLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of direct lights in the scene.
+ */
+export interface IDirectLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    direction: Float32Array;
+}

package/types/lighting/Light.d.ts

@@ -6,10 +6,6 @@ import { ShadowType } from "../shadow";
  * Light base class.
  */
 export declare abstract class Light extends Component {
-    /**
-     * Each type of light source is at most 10, beyond which it will not take effect.
-     * */
-    protected static _maxLight: number;
     /** Light Intensity */
     intensity: number;
     /**

package/types/lighting/LightManager.d.ts

@@ -2,5 +2,12 @@
  * Light manager.
  */
 export declare class LightManager {
+    /**
+     * Each type of light source is at most 10, beyond which it will not take effect.
+     * */
+    private static _maxLight;
+    private _directData;
+    private _pointData;
+    private _spotData;
     private _getSunLightIndex;
 }

package/types/lighting/PointLight.d.ts

@@ -8,7 +8,6 @@ export declare class PointLight extends Light {
     private static _colorProperty;
     private static _positionProperty;
     private static _distanceProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /**
@@ -16,3 +15,12 @@ export declare class PointLight extends Light {
      */
     get position(): Vector3;
 }
+/**
+ * Shader properties data of point lights in the scene.
+ */
+export interface IPointLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    distance: Float32Array;
+}

package/types/lighting/SpotLight.d.ts

@@ -11,7 +11,6 @@ export declare class SpotLight extends Light {
     private static _distanceProperty;
     private static _angleCosProperty;
     private static _penumbraCosProperty;
-    private static _combinedData;
     /** Defines a distance cutoff at which the light's intensity must be considered zero. */
     distance: number;
     /** Angle, in radians, from centre of spotlight where falloff begins. */
@@ -33,3 +32,15 @@ export declare class SpotLight extends Light {
      */
     get reverseDirection(): Vector3;
 }
+/**
+ * Shader properties data of spot lights in the scene.
+ */
+export interface ISpotLightShaderData {
+    cullingMask: Int32Array;
+    color: Float32Array;
+    position: Float32Array;
+    direction: Float32Array;
+    distance: Float32Array;
+    angleCos: Float32Array;
+    penumbraCos: Float32Array;
+}

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -9,11 +9,11 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
     private static _jointCountProperty;
     private static _jointSamplerProperty;
     private static _jointMatrixProperty;
+    private _localBounds;
     private _jointDataCreateCache;
     private _blendShapeWeights;
     private _maxVertexUniformVectors;
     private _rootBone;
-    private _localBounds;
     private _jointMatrices;
     private _jointTexture;
     private _bones;

package/types/particle/ParticleGenerator.d.ts

@@ -1,4 +1,3 @@
-import { ParticleRenderer } from "./ParticleRenderer";
 import { ParticleStopMode } from "./enums/ParticleStopMode";
 import { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
 import { EmissionModule } from "./modules/EmissionModule";
@@ -47,7 +46,6 @@ export declare class ParticleGenerator {
      */
     get randomSeed(): number;
     set randomSeed(value: number);
-    constructor(renderer: ParticleRenderer);
     /**
      * Start emitting particles.
      * @param withChildren - Whether to start the particle generator of the child entity

package/types/particle/enum/ParticleShapeType.d.ts

@@ -1,5 +1,5 @@
 /**
- * The emission shape.
+ * The emission shape type.
  */
 export declare enum ParticleShapeType {
     /** Emit from the volume of a box. */

package/types/particle/index.d.ts

@@ -1,3 +1,4 @@
+export { ParticleGenerator } from "./ParticleGenerator";
 export { ParticleMaterial } from "./ParticleMaterial";
 export { ParticleRenderer } from "./ParticleRenderer";
 export { ParticleCurveMode } from "./enums/ParticleCurveMode";
@@ -7,6 +8,15 @@ export { ParticleScaleMode } from "./enums/ParticleScaleMode";
 export { ParticleSimulationSpace } from "./enums/ParticleSimulationSpace";
 export { ParticleStopMode } from "./enums/ParticleStopMode";
 export { Burst } from "./modules/Burst";
+export { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
+export { EmissionModule } from "./modules/EmissionModule";
+export { MainModule } from "./modules/MainModule";
 export { ParticleCompositeCurve } from "./modules/ParticleCompositeCurve";
+export { ParticleCompositeGradient } from "./modules/ParticleCompositeGradient";
 export { CurveKey, ParticleCurve } from "./modules/ParticleCurve";
+export { GradientAlphaKey, GradientColorKey, ParticleGradient } from "./modules/ParticleGradient";
+export { RotationOverLifetimeModule } from "./modules/RotationOverLifetimeModule";
+export { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
+export { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
+export { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
 export * from "./modules/shape/index";

package/types/particle/module/shape/BaseShape.d.ts

@@ -1,14 +1,13 @@
 import { IClone } from "@galacean/engine-design";
-import { BoundingBox } from "@galacean/engine-math";
 import { ParticleShapeType } from "../../enum/ParticleShapeType";
 /**
  * Configures the initial positions and directions of particles.
  */
-export declare class BaseShape implements IClone {
-    /** The type of shape to emit particles from. */
-    shapeType: ParticleShapeType;
+export declare abstract class BaseShape implements IClone {
     /** Specifies whether the ShapeModule is enabled or disabled. */
     enable: boolean;
+    /** The type of shape to emit particles from. */
+    shapeType: ParticleShapeType;
     /** Randomizes the starting direction of particles. */
     randomDirectionAmount: number;
     /**
@@ -20,7 +19,5 @@ export declare class BaseShape implements IClone {
      * @override
      * @inheritDoc
      */
-    clone(): BaseShape;
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
+    abstract clone(): BaseShape;
 }

package/types/particle/module/shape/BoxShape.d.ts

@@ -1,20 +1,12 @@
+import { Vector3 } from "@galacean/engine-math";
 import { BaseShape } from "./BaseShape";
-import { BoundingBox, Vector3 } from "@galacean/engine-math";
 /**
- * Box emitter shape
+ * Box emitter shape.
  */
 export declare class BoxShape extends BaseShape {
     /** Thickness of the box to emit particles from. */
-    boxThickness: Vector3;
+    size: Vector3;
     constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
     cloneTo(destShape: BoxShape): void;
     clone(): BoxShape;
 }

package/types/particle/module/shape/CircleShape.d.ts

@@ -1,5 +1,5 @@
 import { BaseShape } from "./BaseShape";
-import { BoundingBox, Rand, Vector2, Vector3 } from "@galacean/engine-math";
+import { Rand, Vector2, Vector3 } from "@galacean/engine-math";
 import { ParticleShapeMultiModeValue } from "../../enum";
 /**
  * Circle Particle Emitter
@@ -13,14 +13,6 @@ export declare class CircleShape extends BaseShape {
     /** The mode to generate particles around the arc. */
     arcMode: ParticleShapeMultiModeValue;
     constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
     _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
     cloneTo(destShape: CircleShape): void;
     clone(): CircleShape;

package/types/particle/module/shape/ConeShape.d.ts

@@ -1,5 +1,5 @@
 import { BaseShape } from "./BaseShape";
-import { BoundingBox, Rand, Vector2, Vector3 } from "@galacean/engine-math";
+import { Rand, Vector2, Vector3 } from "@galacean/engine-math";
 export declare enum ConeEmitType {
     Base = 0,
     BaseShell = 1,
@@ -21,14 +21,6 @@ export declare class ConeShape extends BaseShape {
     /** Cone emitter subtype */
     emitType: ConeEmitType;
     constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
     _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
     cloneTo(destShape: ConeShape): void;
     clone(): ConeShape;

package/types/particle/module/shape/HemisphereShape.d.ts

@@ -1,5 +1,5 @@
 import { BaseShape } from "./BaseShape";
-import { BoundingBox, Rand, Vector3 } from "@galacean/engine-math";
+import { Rand, Vector3 } from "@galacean/engine-math";
 /**
  * Hemisphere emitter
  */
@@ -9,14 +9,6 @@ export declare class HemisphereShape extends BaseShape {
     /** Whether emit from shell */
     emitFromShell: boolean;
     constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
     _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
     cloneTo(destShape: HemisphereShape): void;
     clone(): HemisphereShape;

package/types/particle/module/shape/SphereShape.d.ts

@@ -1,5 +1,5 @@
 import { BaseShape } from "./BaseShape";
-import { BoundingBox, Rand, Vector3 } from "@galacean/engine-math";
+import { Rand, Vector3 } from "@galacean/engine-math";
 /**
  * Sphere emitter
  */
@@ -9,14 +9,6 @@ export declare class SphereShape extends BaseShape {
     /** Whether emit from shell */
     emitFromShell: boolean;
     constructor();
-    /**
-     * @inheritDoc
-     */
-    protected _getShapeBoundBox(boundBox: BoundingBox): void;
-    /**
-     * @inheritDoc
-     */
-    protected _getSpeedBoundBox(boundBox: BoundingBox): void;
     _generatePositionAndDirection(position: Vector3, direction: Vector3, rand?: Rand, randomSeeds?: Uint32Array): void;
     cloneTo(destShape: SphereShape): void;
     clone(): SphereShape;

package/types/particle/modules/EmissionModule.d.ts

@@ -13,7 +13,6 @@ export declare class EmissionModule extends ParticleGeneratorModule {
     /** The shape of the emitter. */
     shape: BaseShape;
     private _bursts;
-    private _frameRateTime;
     private _currentBurstIndex;
     private _burstRand;
     /**

package/types/particle/modules/MainModule.d.ts

@@ -26,22 +26,19 @@ export declare class MainModule implements ICustomClone {
     startSpeed: ParticleCompositeCurve;
     /** A flag to enable specifying particle size individually for each axis. */
     startSize3D: boolean;
-    /** The initial size of particles when the Particle Generator first spawns them. */
-    startSize: ParticleCompositeCurve;
     /** The initial size of particles along the x-axis when the Particle Generator first spawns them. */
     startSizeX: ParticleCompositeCurve;
     /** The initial size of particles along the y-axis when the Particle Generator first spawns them. */
     startSizeY: ParticleCompositeCurve;
     /** The initial size of particles along the z-axis when the Particle Generator first spawns them. */
     startSizeZ: ParticleCompositeCurve;
-    /** A flag to enable 3D particle rotation. */
+    /** A flag to enable 3D particle rotation, when disabled, only `startRotationZ` is used. */
     startRotation3D: boolean;
-    /** The initial rotation of particles when the Particle Generator first spawns them. */
-    startRotation: ParticleCompositeCurve;
     /** The initial rotation of particles around the x-axis when emitted.*/
     startRotationX: ParticleCompositeCurve;
     /** The initial rotation of particles around the y-axis when emitted. */
     startRotationY: ParticleCompositeCurve;
+    /** The initial rotation of particles around the z-axis when emitted. */
     startRotationZ: ParticleCompositeCurve;
     /** Makes some particles spin in the opposite direction. */
     flipRotation: number;
@@ -57,7 +54,6 @@ export declare class MainModule implements ICustomClone {
     scalingMode: ParticleScaleMode;
     /** If set to true, the Particle Generator automatically begins to play on startup. */
     playOnEnabled: boolean;
-    private _maxParticles;
     private _generator;
     private _gravity;
     /**
@@ -65,4 +61,9 @@ export declare class MainModule implements ICustomClone {
      */
     get maxParticles(): number;
     set maxParticles(value: number);
+    /**
+     * The initial size of particles when the Particle Generator first spawns them.
+     */
+    get startSize(): ParticleCompositeCurve;
+    set startSize(value: ParticleCompositeCurve);
 }

package/types/particle/modules/ParticleGeneratorModule.d.ts

@@ -7,6 +7,5 @@ export declare abstract class ParticleGeneratorModule {
     /** Specifies whether the module is enabled or not. */
     enabled: boolean;
     protected _generator: ParticleGenerator;
-    constructor(generator: ParticleGenerator);
     protected _enableMacro(shaderData: ShaderData, lastEnableMacro: ShaderMacro, enableMacro: ShaderMacro): ShaderMacro;
 }

package/types/particle/modules/RotationOverLifetimeModule.d.ts

@@ -18,7 +18,7 @@ export declare class RotationOverLifetimeModule extends ParticleGeneratorModule
     static readonly _maxCurveXProperty: ShaderProperty;
     static readonly _maxCurveYProperty: ShaderProperty;
     static readonly _maxCurveZProperty: ShaderProperty;
-    /** Specifies whether the rotation is separate on each axis, when disabled only z axis is used. */
+    /** Specifies whether the rotation is separate on each axis, when disabled, only `rotationZ` is used. */
     separateAxes: boolean;
     /** Rotation over lifetime for z axis. */
     rotationX: ParticleCompositeCurve;

package/types/particle/modules/TextureSheetAnimationModule.d.ts

@@ -26,10 +26,6 @@ export declare class TextureSheetAnimationModule extends ParticleGeneratorModule
      * */
     get tiling(): Vector2;
     set tiling(value: Vector2);
-    /**
-     * @inheritDoc
-     */
-    cloneTo(dest: TextureSheetAnimationModule): void;
 }
 /**
  * Texture sheet animation type.

package/types/particle/moudules/Burst.d.ts

@@ -4,12 +4,20 @@ import { ParticleCurve } from "./ParticleCurve";
  * A burst is a particle emission event, where a number of particles are all emitted at the same time
  */
 export declare class Burst implements IClone {
-    time: number;
-    count: ParticleCurve;
+    private _time;
+    private _count;
+    /**
+     * The time that each burst occurs.
+     */
+    get time(): number;
+    /**
+     * The number of particles to emit.
+     */
+    get count(): ParticleCurve;
     /**
      * Create burst object.
-     * @param time - Time to emit the burst
-     * @param count - Count of particles to emit
+     * @param time - Time to emit the burst.
+     * @param count - Minimum number of particles to emit.
      */
     constructor(time: number, count: ParticleCurve);
     /**

package/types/particle/moudules/Emission.d.ts

@@ -1,25 +1,41 @@
-import { IClone } from "@galacean/engine-design";
 import { Burst } from "./Burst";
-import { ParticleCurve } from "./ParticleCurve";
+import { IClone } from "@galacean/engine-design";
 /**
  * The EmissionModule of a Particle System.
  */
 export declare class EmissionModule implements IClone {
+    private _emissionRate;
+    private _emissionRateOverDistance;
+    private _bursts;
     /** Specifies whether the EmissionModule is enabled or disabled. */
     enable: boolean;
-    /**  The rate of particle emission. */
-    rateOverTime: ParticleCurve;
-    /**  The rate at which the emitter spawns new particles over distance. */
-    rateOverDistance: ParticleCurve;
-    private _bursts;
+    /**
+     * The rate of particle emission.
+     */
+    get emissionRate(): number;
+    set emissionRate(value: number);
+    /**
+     * The rate at which the emitter spawns new particles over distance.
+     */
+    get emissionRateOverDistance(): number;
+    set emissionRateOverDistance(value: number);
     /**
      * Gets the burst array.
      */
-    get bursts(): ReadonlyArray<Burst>;
-    constructor();
+    get bursts(): Burst[];
+    /**
+     * The current number of bursts.
+     */
+    get burstCount(): number;
     /**
-     * Add a single burst.
-     * @param burst - The burst
+     * Gets a single burst from the array of bursts.
+     * @param index - The index of the burst to retrieve.
+     * @return The burst data at the given index.
+     */
+    getBurstByIndex(index: number): Burst;
+    /**
+     * Add a single burst from the array of bursts.
+     * @param burst - The burst data
      */
     addBurst(burst: Burst): void;
     /**