Lens Scripting API
    Preparing search index...

    Class InteractableOutlineFeedback

    This class provides visual feedback by adding an outline to mesh visuals when they are hovered or pinched. It allows customization of the outline color, thickness, and target meshes.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    activatingColor api enabled hoveringColor isBeingDestroyed isEnabledInHierarchy meshVisuals name outlineWeight sceneObject targetOutlineMaterial uniqueIdentifier updateOrder updatePriority

    Methods

    addMaterialToRenderMeshArray createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName init isOfType isSame onAwake removeEvent removeMaterialFromRenderMeshArray requestPersistInput setupInteractableCallbacks

    Constructors

    Properties

    activatingColor: vec4 = ...

    This is the color of the outline when triggered.

    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
    hoveringColor: vec4 = ...

    This is the color of the outline when hovered.

    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.

    meshVisuals: RenderMeshVisual[] = []

    These are the meshes that will be outlined on pinch/hover.

    name: string
    outlineWeight: number = 0.25

    This is the thickness of the outline.

    sceneObject: SceneObject

    The SceneObject this component is on.

    targetOutlineMaterial: Material

    This is the material that will provide the mesh outline.

    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 void

    • 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>>

    • Returns void

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

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods