Class SnapshotBuffer<TStorageType>

constructor

• new SnapshotBuffer<TStorageType extends StorageTypes>(
      options?:
          | SnapshotBufferOptions<TStorageType>
          | SnapshotBufferOptionsObj<TStorageType>,
  ): SnapshotBuffer<TStorageType>

  Type Parameters

  • TStorageType extends StorageTypes

  Parameters

  • Optionaloptions: SnapshotBufferOptions<TStorageType> | SnapshotBufferOptionsObj<TStorageType>

    Options for the buffer

  Returns SnapshotBuffer<TStorageType>

interpolationTarget

StaticcreateFromOptions

• createFromOptions<U extends StorageTypes>(
      options?: SnapshotBufferOptions<U> | SnapshotBufferOptionsObj<U>,
  ): SnapshotBuffer<U>

  Type Parameters

  • U extends StorageTypes

  Parameters

  • Optionaloptions: SnapshotBufferOptions<U> | SnapshotBufferOptionsObj<U>

    Options for the buffer

  Returns SnapshotBuffer<U>

  SnapshotBuffer

getLerpedValue

• getLerpedValue(timestamp: number): StorageTypeToPrimitive[TStorageType]

  Parameters

  • timestamp: number

    Time in seconds

  Returns StorageTypeToPrimitive[TStorageType]

  Value at the given time

getMostRecentValue

• getMostRecentValue(): StorageTypeToPrimitive[TStorageType]

  Returns StorageTypeToPrimitive[TStorageType]

  Most recent value

saveSnapshot

• saveSnapshot(
      timestamp: number,
      value: StorageTypeToPrimitive[TStorageType],
  ): SyncSnapshot<StorageTypeToPrimitive[TStorageType]>

  Parameters

  • timestamp: number

    Time in local seconds
  • value: StorageTypeToPrimitive[TStorageType]

    Value to store

  Returns SyncSnapshot<StorageTypeToPrimitive[TStorageType]>

  Snapshot of the value

setCurrentValue

• setCurrentValue(
      currentTime: number,
      value: StorageTypeToPrimitive[TStorageType],
  ): SyncSnapshot<StorageTypeToPrimitive[TStorageType]>

  Parameters

  • currentTime: number

    Time in seconds
  • value: StorageTypeToPrimitive[TStorageType]

    Value to set

  Returns SyncSnapshot<StorageTypeToPrimitive[TStorageType]>

  Snapshot of the value