Preparing search index...

    This class provides audio feedback for interactable objects. It allows configuration of audio tracks for hover, trigger start, and trigger end events. The class also provides access to the audio component for further customization.

    Hierarchy (View Summary)

    Index

    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 hoverAudioComponent(): AudioComponent

      Returns the AudioComponent used for hover feedback for further configuration (such as volume).

      Returns AudioComponent

    • get hoverAudioTrack(): AudioTrackAsset

      Returns AudioTrackAsset

      the AudioTrackAsset to play when the Interactable receives a hover event.

    • set hoverAudioTrack(track: AudioTrackAsset): void

      Set the AudioTrackAsset to play when the Interactable receives a hover event.

      Parameters

      Returns void

    • get playAudioOnHover(): boolean

      Returns boolean

      if audio should play when the Interactable receives a hover event.

    • set playAudioOnHover(enabled: boolean): void

      Set if audio should play when the Interactable receives a hover event.

      Parameters

      • enabled: boolean

      Returns void

    • get playAudioOnTriggerEnd(): boolean

      Returns boolean

      if audio should play when the Interactable receives a trigger end event.

    • set playAudioOnTriggerEnd(enabled: boolean): void

      Set if audio should play when the Interactable receives a trigger end event.

      Parameters

      • enabled: boolean

      Returns void

    • get playAudioOnTriggerStart(): boolean

      Returns boolean

      if audio should play when the Interactable receives a trigger start event.

    • set playAudioOnTriggerStart(enabled: boolean): void

      Set if audio should play when the Interactable receives a trigger start event.

      Parameters

      • enabled: boolean

      Returns void

    • get triggerEndAudioComponent(): AudioComponent

      Returns the AudioComponent used for trigger end feedback for further configuration (such as volume).

      Returns AudioComponent

    • get triggerEndAudioTrack(): AudioTrackAsset

      Returns AudioTrackAsset

      the AudioTrackAsset to play when the Interactable receives a trigger end event.

    • set triggerEndAudioTrack(track: AudioTrackAsset): void

      Set the AudioTrackAsset to play when the Interactable receives a trigger end event.

      Parameters

      Returns void

    • get triggerStartAudioComponent(): AudioComponent

      Returns the AudioComponent used for trigger start feedback for further configuration (such as volume).

      Returns AudioComponent

    • get triggerStartAudioTrack(): AudioTrackAsset

      Returns AudioTrackAsset

      the AudioTrackAsset to play when the Interactable receives a trigger start event.

    • set triggerStartAudioTrack(track: AudioTrackAsset): void

      Set the AudioTrackAsset to play when the Interactable receives a trigger start event.

      Parameters

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

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

      Parameters

      • type: string

      Returns boolean

    • Returns void