Interface LocationAsset

Provides a frame of reference in which to localize objects to the real world. Use with LocatedAtComponent.

interface LocationAsset {
    name: string;
    uniqueIdentifier: string;
    adjacentTile(xOffset: number, yOffset: number, zoomOffset: number): LocationAsset;
    getProxyId(): string;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

name uniqueIdentifier

Methods

adjacentTile getProxyId getTypeName isOfType isSame

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

adjacentTile

  • adjacentTile(xOffset, yOffset, zoomOffset): LocationAsset

  • Returns the LocationAsset Tile that is specified by the containing tile and the specified xOffset, yOffset and zoomOffset. When zooming in, index offset is relative to the center. When zooming out or not zooming, index offset is relative to the containing tile.

    Parameters

    • xOffset: number
    • yOffset: number
    • zoomOffset: number

    Returns LocationAsset

getProxyId

  • getProxyId(): string

  • Gets the Proxy LocationID if the LocationAsset is a proxyLocation; returns null otherwise. This is useful in instances where a callback may return a mix of different location assets, and the creator of the proxy asset has specific handling in mind for particular proxy locations.

    Returns string

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

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