Class KeyframeRecord

constructor

• new KeyframeRecord(path: string): KeyframeRecord

  Creates a new KeyframeRecord instance.

  Parameters

  • path: string

    The path to the SQLite database file.

  Returns KeyframeRecord

db

path

ready

addKeyframe

• addKeyframe(
      offset: number,
      totalActionCount: number,
      bufferActionCount: any,
      template: string,
      voxelData: Buffer<ArrayBufferLike>,
      bounds: Vector3,
      levelData?: string,
  ): Promise<number>

  Adds a keyframe to the database.

  Parameters

  • offset: number

    The offset in the VHS file.

  • totalActionCount: number

    The action count at this keyframe.

  • bufferActionCount: any
  • template: string

    The template associated with this keyframe.

  • voxelData: Buffer<ArrayBufferLike>

    The level voxel data at this keyframe.

  • bounds: Vector3

    The bounds of the level.

  • OptionallevelData: string = "{}"

    Optional level data in JSON format. Default is "{}"

  Returns Promise<number>

  The ID of the newly created keyframe.

close

• close(): Promise<void>

  Close the database connection.

  Returns Promise<void>

getLatestKeyframe

• getLatestKeyframe(
      beforeActionCount: number,
      template: string,
      bounds: Vector3,
  ): Promise<any>

  Gets the latest keyframe before a given action count for a specific template.

  Parameters

  • beforeActionCount: number

    The action count to search before.

  • template: string

    The template to filter by.

  • bounds: Vector3

    The bounds of the level.

  Returns Promise<any>

  The latest keyframe record or null if not found.

purgeKeyframes

• purgeKeyframes(afterActionCount: number): Promise<number>

  Purge keyframes after a specific action count.

  Parameters

  • afterActionCount: number

    The action count to purge keyframes after.

  Returns Promise<number>

  The number of rows deleted.

vacuum

• vacuum(): Promise<void>

  Vacuum the database to optimize it.

  Returns Promise<void>

StaticgetBoundsKey

• getBoundsKey(bounds: Vector3): string

  Get a string key for level bounds.

  Parameters

  • bounds: Vector3

    The bounds to generate a key for.

  Returns string

  The string key for the bounds.