Lens Scripting API
    Preparing search index...

    Class FrameButton

    Used to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity. Top level contents of a JS file will run as an OnAwakeEvent.

    These Script Components are attached to SceneObjects, providing the ability to modify properties and behaviors of those objects or others within the scene. Script Components expose input fields in the Inspector panel, allowing for customization of script behavior without altering code. Any script can access the ScriptComponent executing them through the variable script.

    // Bind a function to the MouthOpened event
    function onMouthOpen(eventData)
    {
        print("mouth was opened");
    }
    var event = script.createEvent("MouthOpenedEvent");
    event.bind(onMouthOpen);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    api enabled image isBeingDestroyed isEnabledInHierarchy name sceneObject uniqueIdentifier updateOrder updatePriority

    Methods

    createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName initialize isOfType isSame removeEvent requestPersistInput

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    image: Image
    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.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number

    The relative execution order of this script's lifecycle callbacks (onStart, onUpdate, onLateUpdate, etc.) among all scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Reflects the updateOrder set on the attached ScriptAsset. Defaults to 0.

    updateOrder only orders scripts relative to each other; it does not affect ordering relative to non-script engine Components.

    Lens Scripting Version 367

    if (script.updateOrder < 0) {
        // This script runs before scripts at the default updateOrder.
    }
    updatePriority: number

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Type Parameters

      Parameters

      • this: T

      Returns TypeName<InstanceType<T>>

    • Initializes the button

      Parameters

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods