Class BaseSqliteAdapter

constructor

• new BaseSqliteAdapter(
      keyframeRecord: KeyframeRecord,
      openPath: PathLike,
  ): BaseSqliteAdapter

  Parameters

  • keyframeRecord: KeyframeRecord
  • openPath: PathLike

    The path used for identifying the store. Likely, it's somewhere that exists on a local filesystem.

  Returns BaseSqliteAdapter

db

keyframeRecord

addKeyframe

• addKeyframe(
      offset: number,
      totalActionCount: number,
      bufferActionCount: number,
      template: string,
      compressedVoxelData: 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 action count at this keyframe.

  • bufferActionCount: number

    Yet to be documented.

  • template: string

    The template associated with this keyframe.

  • compressedVoxelData: 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>

Abstractclose

• close(): Promise<any>

  Close the database connection.

  Returns Promise<any>

ensureInitializedDatabase

• ensureInitializedDatabase(): Promise<void>

  Ensures the database is initialized by creating tables and indexes if they don't exist

  Returns Promise<void>

Abstractexecute

• execute(statement: Statement, parameters?: any[]): Promise<any>

  Executes the specified Statement object.

  Parameters

  • statement: Statement

    The Statement instance to execute.

  • Optionalparameters: any[]

    The parameters to pass into the parameterized statement.

  Returns Promise<any>

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.

AbstractinitializeDatabase

• initializeDatabase(path?: any): Promise<any>

  Initializes the database object.

  Parameters

  • Optionalpath: any

  Returns Promise<any>

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>

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.