Interface LocationCloudStorageOptions

Description

Used to configure LocationCloudStorage module with various options.

interface LocationCloudStorageOptions {
    collection: string;
    location: LocationAsset;
    onDiscoveredNearby: event2<LocationAsset, LocationCloudStore, void>;
    onError: event3<LocationAsset, string, string, void>;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

collection location onDiscoveredNearby onError

Methods

getTypeName isOfType isSame

Properties

collection

collection: string

Description

Tag to represent a collection of objects/entities

location

location: LocationAsset

Description

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>

Description

Event raised on discovery of nearby cloud stores.

Readonly onError

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

Description

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

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc