Class InteractableAudioFeedback

Binds scripts to Events and executes them when triggered. Any script can access the ScriptComponent executing them through the variable script. See also: Scripting Overview, Script Events Guide.

Example

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
    print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);

Hierarchy (view full)

Constructors

constructor

Properties

api enabled hoverAudioTrack name sceneObject triggerEndAudioTrack triggerStartAudioTrack uniqueIdentifier updatePriority

Accessors

hoverAudioComponent triggerEndAudioComponent triggerStartAudioComponent

Methods

createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName isOfType isSame onAwake removeEvent getTypeName

Constructors

constructor

Properties

api

api: Record<string, any>

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

hoverAudioTrack

hoverAudioTrack: AudioTrackAsset

name

name: string

ReadonlysceneObject

sceneObject: SceneObject

triggerEndAudioTrack

triggerEndAudioTrack: AudioTrackAsset

triggerStartAudioTrack

triggerStartAudioTrack: AudioTrackAsset

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

hoverAudioComponent

  • get hoverAudioComponent(): AudioComponent

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

    Returns AudioComponent

triggerEndAudioComponent

  • get triggerEndAudioComponent(): AudioComponent

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

    Returns AudioComponent

triggerStartAudioComponent

  • get triggerStartAudioComponent(): AudioComponent

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

    Returns AudioComponent

Methods

createEvent

destroy

getReferencedEvents

getSceneObject

getTransform

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

onAwake

  • onAwake(): void

  • Returns void

removeEvent

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods