Lens Scripting API

    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, Expand)

    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.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    name: string
    sceneObject: SceneObject

    The scene object this component is on.

    uniqueIdentifier: string
    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 true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    MMNEPVFCICPMFPCPTTAAATR