Class DataStoreUpdate

constructor

• new DataStoreUpdate(
      dataStoreName: string,
      property: string,
      path: string,
      value: string | number | boolean,
      propertyUpdateCount: number,
      pathUpdateCount: number,
  ): DataStoreUpdate

  Creates a new instance of the DataStoreUpdate class.

  Parameters

  • dataStoreName: string

    The name of the data store that was updated.
  • property: string

    The name of the property that was updated. This is used to identify which property was updated when reading from the binary stream.
  • path: string

    The path of the property that was updated. This is used to identify which property was updated when reading from the binary stream.
  • value: string | number | boolean

    The new value of the property after the update.
  • propertyUpdateCount: number

    The number of times the property has been updated, including this update.
  • pathUpdateCount: number

    The number of times the property has been updated, including this update. This is used to determine if an update is out of order or if an update was missed.

  Returns DataStoreUpdate

dataStoreName

path

pathUpdateCount

property

propertyUpdateCount

ReadonlytypeId

value

Staticread

• read(stream: BinaryStream): DataStoreUpdate

  Read a value from the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to read from.

  Returns DataStoreUpdate

  The value read from the stream.

Staticwrite

• write(stream: BinaryStream, value: DataStoreUpdate): void

  Write a value to the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to write to.
  • value: DataStoreUpdate

    The value to write.

  Returns void