Lens Scripting API
    Preparing search index...

    Class InteractableStateMachine

    Used to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity.

    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 events interactable isDraggable isEnabledInHierarchy isToggle name onDefault onHovered onToggledDefault onToggledHovered onToggledTriggered onTriggered sceneObject uniqueIdentifier untoggleOnClick updatePriority

    Accessors

    state toggle

    Methods

    createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName initialize isOfType isSame onAwake removeEvent transition

    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.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    events: {
        hovered: Event<StateEvent>;
        interactableStateMachineInteractableStateMachineEventsType: Event<
            StateEvent,
        >;
        toggledDefault: Event<StateEvent>;
        toggledHovered: Event<StateEvent>;
        toggledTriggered: Event<StateEvent>;
        triggered: Event<StateEvent>;
    } = ...
    interactable: Interactable = ...
    isDraggable: boolean = false
    isEnabledInHierarchy: boolean

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

    isToggle: boolean = false
    name: string
    onDefault: PublicApi<StateEvent> = ...
    onHovered: PublicApi<StateEvent> = ...
    onToggledDefault: PublicApi<StateEvent> = ...
    onToggledHovered: PublicApi<StateEvent> = ...
    onToggledTriggered: PublicApi<StateEvent> = ...
    onTriggered: PublicApi<StateEvent> = ...
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    untoggleOnClick: boolean = true
    updatePriority: number

    Accessors

    • get state(): State

      Returns State

    • set state(newState: State): void

      Parameters

      • newState: State

      Returns void

    • get toggle(): boolean

      Returns boolean

    • set toggle(on: boolean): void

      Parameters

      • on: boolean

      Returns void

    Methods

    • 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