Lens Scripting API
    Preparing search index...

    Class DropShadow

    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 isBeingDestroyed isEnabledInHierarchy name sceneObject uniqueIdentifier updateOrder updatePriority

    Accessors

    color cornerRadius renderMeshVisual renderOrder size spread

    Methods

    createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName initialize isOfType isSame onAwake 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
    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

    Accessors

    • get color(): vec4

      The color of the drop shadow.

      Returns vec4

    • set color(value: vec4): void

      The color of the drop shadow.

      Parameters

      • value: vec4

        The new color of the drop shadow.

      Returns void

    • get cornerRadius(): number

      The corner radius of the drop shadow.

      Returns number

    • set cornerRadius(value: number): void

      The corner radius of the drop shadow.

      Parameters

      • value: number

        The new corner radius of the drop shadow.

      Returns void

    • get renderOrder(): number

      The render order of the shadow.

      Returns number

    • set renderOrder(value: number): void

      The render order of the shadow.

      Parameters

      • value: number

      Returns void

    • get size(): vec2

      The size of the drop shadow.

      Returns vec2

    • set size(value: vec2): void

      The size of the drop shadow.

      Parameters

      • value: vec2

        The new size of the drop shadow.

      Returns void

    • get spread(): number

      The spread amount of the drop shadow.

      Returns number

    • set spread(spread: number): void

      The spread amount of the drop shadow.

      Parameters

      • spread: number

        The new spread amount of the drop shadow.

      Returns void

    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 drop shadow component. This method creates a RoundedRectangle component and sets its properties based on the input parameters.

      Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods