Class CloudStore

An instance of Cloud Storage that can store data in a multiplayer experience.

Hierarchy (View Summary, Expand)

ScriptObject
- CloudStore

Index

Constructors

Methods

deleteValue getTypeName getValue isOfType isSame listValues setValue

Constructors

`Protected`constructor

new CloudStore(): CloudStore
Returns CloudStore
Overrides ScriptObject.constructor

Methods

deleteValue

deleteValue(
    key: string,
    readOptions: CloudStorageReadOptions,
    onDeleted: () => void,
    onError: (code: string, description: string) => void,
): void
Deletes a value from the persistence backend. Note that the scope must match that which was used when the value was originally saved.
Parameters
- key: string
- readOptions: CloudStorageReadOptions
- onDeleted: () => void
- onError: (code: string, description: string) => void
Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

getValue

getValue(
    key: string,
    readOptions: CloudStorageReadOptions,
    onRetrieved: (
        key: string,
        value:
            | string
            | number
            | boolean
            | vec4
            | vec3
            | quat
            | mat4
            | vec2
            | mat3
            | mat2,
    ) => void,
    onError: (code: string, description: string) => void,
): void
Gets a value from the persistence backend. Note that scope must match that which was used when the value was originally saved.
Parameters
- key: string
- readOptions: CloudStorageReadOptions
- onRetrieved: (
      key: string,
      value:
          | string
          | number
          | boolean
          | vec4
          | vec3
          | quat
          | mat4
          | vec2
          | mat3
          | mat2,
  ) => void
- onError: (code: string, description: string) => void
Returns void

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame

listValues

listValues(
    listOptions: CloudStorageListOptions,
    onRetrieved: (
        values: (
            | string
            | number
            | boolean
            | vec4
            | vec3
            | quat
            | mat4
            | vec2
            | mat3
            | mat2
        )[][],
        cursor: string,
    ) => void,
    onError: (code: string, description: string) => void,
): void
Lists values from the persistence backend. Note that the scope must match that which was used when the values were originally saved.
Parameters
- listOptions: CloudStorageListOptions
- onRetrieved: (
      values: (
          | string
          | number
          | boolean
          | vec4
          | vec3
          | quat
          | mat4
          | vec2
          | mat3
          | mat2
      )[][],
      cursor: string,
  ) => void
- onError: (code: string, description: string) => void
Returns void

setValue

setValue(
    key: string,
    value:
        | string
        | number
        | boolean
        | vec4
        | vec3
        | quat
        | mat4
        | vec2
        | mat3
        | mat2,
    writeOptions: CloudStorageWriteOptions,
    onSaved: () => void,
    onError: (code: string, description: string) => void,
): void
Sets a value in the persistence backend.
Parameters
- key: string
- value: string | number | boolean | vec4 | vec3 | quat | mat4 | vec2 | mat3 | mat2
- writeOptions: CloudStorageWriteOptions
- onSaved: () => void
- onError: (code: string, description: string) => void
Returns void