Class LocationCloudStorageOptions

Used to configure LocationCloudStorage module with various options.

Hierarchy (View Summary, Expand)

ScriptObject
- LocationCloudStorageOptions

Index

Constructors

Properties

collection location onDiscoveredNearby onError

Methods

create getTypeName isOfType isSame

Constructors

`Protected`constructor

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

Properties

collection

collection: string

Tag to represent a collection of objects/entities

location

location: LocationAsset

Provides a frame of reference in which to localize objects to the real world. Could be any location type.

`Readonly`onDiscoveredNearby

onDiscoveredNearby: event2<LocationAsset, LocationCloudStore, void>

Event raised on discovery of nearby cloud stores.

`Readonly`onError

onError: event3<LocationAsset, string, string, void>

Error event raised when failing to instantiate a location cloud store associated with that location asset.

Methods

`Static`create

create(): LocationCloudStorageOptions
Create options to provide to LocationCloudStorageModule

Returns LocationCloudStorageOptions

getTypeName

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

Returns string
Inherited from ScriptObject.getTypeName

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