Interface LocationCloudStorageOptions

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: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

collection location onDiscoveredNearby onError

Methods

getTypeName isOfType isSame

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.

ReadonlyonDiscoveredNearby

onDiscoveredNearby: event2<LocationAsset, LocationCloudStore, void>

Event raised on discovery of nearby cloud stores.

ReadonlyonError

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

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

Methods

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

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

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods