Class KeyframeRecord

constructor

• new KeyframeRecord(
      path: string,
      adapterClass:
          | typeof BetterSqliteAdapter
          | typeof GhostSqliteAdapter
          | typeof NativeSqliteAdapter,
  ): KeyframeRecord

  Creates a new KeyframeRecord instance.

  Parameters

  • path: string

    The path to the SQLite database file.

  • adapterClass:
        | typeof BetterSqliteAdapter
        | typeof GhostSqliteAdapter
        | typeof NativeSqliteAdapter

    The adapter class to use. Must be any class that inherits BaseSqliteAdapter.

  Returns KeyframeRecord

adapter

path

addKeyframe

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

  Adds a keyframe to the database.

  Parameters

  • offset: number

    The offset in the VHS file.

  • totalActionCount: number

    The total action count at this keyframe

  • bufferActionCount: number

    The number of actions recorded after the last keyframe.

  • 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<void>

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<void>

  Purge keyframes after a specific action count.

  Parameters

  • afterActionCount: number

    The action count to purge keyframes after.

  Returns Promise<void>

vacuum

• vacuum(): Promise<void>

  Vacuum the database to optimize it.

  Returns Promise<void>

StaticfindSuitableSqliteAdapter

• findSuitableSqliteAdapter(): Promise<
      | void
      | typeof BetterSqliteAdapter
      | typeof GhostSqliteAdapter
      | typeof NativeSqliteAdapter,
  >

  Finds a suitable SQLite adapter. I use dynamic imports to find an adapter that is able to import.

  I attempt to import the following adapter classes in order:

  1. BetterSqliteAdapter - Uses the better-sqlite3 optional dependency.
  2. GhostSqliteAdapter - Uses the sqlite3 optional dependency.
  3. NativeSqliteAdapter - Uses the experimental native Node.js SQLite module. If I use this adapter, its module will emit a warning on import.

  If I can't find an adapter, I'll throw an Error.

  Returns Promise<
      | void
      | typeof BetterSqliteAdapter
      | typeof GhostSqliteAdapter
      | typeof NativeSqliteAdapter,
  >

  Throws

  If no adapter could be imported.

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.