Lens Scripting API
    Preparing search index...

    Class LocatedAtComponent

    Enables placing a SceneObject at a real world location provided by LocationAsset and specified relative position.

    Hierarchy (View Summary)

    Index

    Properties

    distanceToLocation enabled isBeingDestroyed isEnabledInHierarchy location onCannotTrack onCanTrack onError onFound onLost onReady position proximityStatus sceneObject uniqueIdentifier

    Methods

    createMappingOptions createMappingSession destroy getSceneObject getTransform getTypeName isOfType isSame

    Properties

    distanceToLocation: number

    Lens Scripting Version 197

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
        // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    location: LocationAsset

    The LocationAsset which contains the position this object should be anchored to.

    Lens Scripting Version 172

    null
    onCannotTrack: event0<void>

    Lens Scripting Version 197

    onCanTrack: event0<void>

    Lens Scripting Version 197

    onError: event0<void>

    Lens Scripting Version 197

    onFound: event0<void>

    Lens Scripting Version 197

    onLost: event0<void>

    Lens Scripting Version 197

    onReady: event0<void>

    Lens Scripting Version 197

    position: vec3

    The geo anchored position within a LocationAsset that this object should be anchored to.

    Lens Scripting Version 172

    (0, 0, 0)
    proximityStatus: LocationProximityStatus
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    Methods

    • Creates an option object for the LocatedAtComponent.

      Returns MappingOptions

      Lens Scripting Version 229

    • Destroys the component.

      Returns void

    • Returns the name of this object's type.

      Returns string

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

      Parameters

      • type: string

      Returns 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