Lens Scripting API
    Preparing search index...

    Class ScriptAsset

    Represents a JavaScript or TypeScript script that can be used to add logic in your Lens.

    Lens Scripting Version 176

    Hierarchy (View Summary)

    Index

    Properties

    name uniqueIdentifier updateOrder

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    name: string

    The name of the Asset in Lens Studio.

    ""
    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number

    Determines the order in which this script's lifecycle callbacks (onAwake, onStart, onUpdate, onLateUpdate, etc.) fire relative to other scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Defaults to 0. Advisory range: [-1000, +1000]. Immutable at runtime.

    updateOrder only orders scripts relative to other scripts; it does not affect ordering relative to engine components. Lens Studio provides an Inspector field for editing this at design time.

    Lens Scripting Version 367

    //@input Asset.ScriptAsset controllerScript
    print("controllerScript updateOrder: " + script.controllerScript.updateOrder);

    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().

      Returns string

      Lens Scripting Version 176

    • 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