Class Interactable

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

allowMultipleInteractors api colliders enabled enableInstantDrag isScrollable name onDragEnd onDragStart onDragUpdate onHoverEnter onHoverExit onHoverUpdate onInteractorHoverEnter onInteractorHoverExit onInteractorTriggerEnd onInteractorTriggerStart onTriggerCanceled onTriggerEnd onTriggerStart onTriggerUpdate sceneObject targetingMode transform uniqueIdentifier updatePriority

Accessors

hoveringInteractor triggeringInteractor

Methods

createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName hoverEnter hoverExit hoverUpdate isOfType isSame onAwake release removeEvent triggerCanceled triggerEnd triggerStart triggerUpdate getTypeName

Constructors

constructor

Properties

allowMultipleInteractors

allowMultipleInteractors: boolean = true

Determines whether one or more interactors can interactor with this interactable

api

api: Record<string, any>

colliders

colliders: ColliderComponent[] = []

Provides all colliders associated with this Interactable

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

enableInstantDrag

enableInstantDrag: boolean = false

isScrollable

isScrollable: boolean = false

Returns if an Interactable is scrollable

name

name: string

onDragEnd

onDragEnd: PublicApi<DragInteractorEvent> = ...

Called when an interactor was in a down event with this interactable and was dragging

onDragStart

onDragStart: PublicApi<DragInteractorEvent> = ...

Called when an interactor is in a down event with this interactable and has moved a minimum drag distance

onDragUpdate

onDragUpdate: PublicApi<DragInteractorEvent> = ...

Called when an interactor is in a down event with this interactable and is moving

onHoverEnter

onHoverEnter: PublicApi<InteractorEvent> = ...

Called whenever the interactable enters the hovered state

onHoverExit

onHoverExit: PublicApi<InteractorEvent> = ...

Called whenever the interactable is no longer hovered

onHoverUpdate

onHoverUpdate: PublicApi<InteractorEvent> = ...

Called whenever an interactor remains hovering over this interactable

onInteractorHoverEnter

onInteractorHoverEnter: PublicApi<InteractorEvent> = ...

Called whenever a new interactor hovers over this interactable

onInteractorHoverExit

onInteractorHoverExit: PublicApi<InteractorEvent> = ...

Called whenever an interactor exits hovering this interactable

onInteractorTriggerEnd

onInteractorTriggerEnd: PublicApi<InteractorEvent> = ...

Called whenever an interactor is no longer triggering the interactable

onInteractorTriggerStart

onInteractorTriggerStart: PublicApi<InteractorEvent> = ...

Called whenever an interactor triggers an interactable

onTriggerCanceled

onTriggerCanceled: PublicApi<InteractorEvent> = ...

Called whenever an interactor is lost and was in a down event with this interactable

onTriggerEnd

onTriggerEnd: PublicApi<InteractorEvent> = ...

Called whenever the interactable exits the triggered state

onTriggerStart

onTriggerStart: PublicApi<InteractorEvent> = ...

Called whenever the interactable enters the triggered state

onTriggerUpdate

onTriggerUpdate: PublicApi<InteractorEvent> = ...

Called whenever an interactor continues to trigger an interactable

ReadonlysceneObject

sceneObject: SceneObject

targetingMode

targetingMode: number = 3

Defines how an interactor can interact with this interactable. Values are: 1: Direct 2: Indirect 3: Direct/Indirect 4: Poke

transform

transform: Transform

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Accessors

hoveringInteractor

triggeringInteractor

Methods

createEvent

destroy

getReferencedEvents

getSceneObject

getTransform

getTypeName

hoverEnter

  • hoverEnter(eventArgs): void

  • Notifies the interactable that it is entering hover state

    Parameters

    Returns void

hoverExit

  • hoverExit(eventArgs): void

  • Notifies the interactable that it is exiting hover state

    Parameters

    Returns void

hoverUpdate

  • hoverUpdate(eventArgs): void

  • Notifies the interactable that it is still hovering

    Parameters

    Returns void

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

release

  • release(): void

  • Returns void

removeEvent

triggerCanceled

  • triggerCanceled(eventArgs): void

  • Notifies the interactable that it is a cancelled state with the interactor

    Parameters

    Returns void

triggerEnd

  • triggerEnd(eventArgs): void

  • Notifies the interactable that it is exiting trigger state

    Parameters

    Returns void

triggerStart

  • triggerStart(eventArgs): void

  • Notifies the interactable that it is entering trigger state

    Parameters

    Returns void

triggerUpdate

  • triggerUpdate(eventArgs): void

  • Notifies the interactable that it is still in a triggering state

    Parameters

    Returns void

StaticgetTypeName

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods