Class InteractionManager

constructor

• new InteractionManager(): InteractionManager

• Returns InteractionManager

StaticgetInstance

deregisterInteractable

• deregisterInteractable(interactable): void

• Removes an Interactable from the interaction manager's registry.

  Parameters

  • interactable: Interactable

    The Interactable to deregister.

  Returns void

deregisterInteractor

• deregisterInteractor(interactor): void

• Removes an Interactor from the interaction manager's registry, so that it will no longer be considered when determining which interactors are interacting with interactables.

  Parameters

  • interactor: Interactor

    The Interactor to deregister.

  Returns void

dispatchEvent

• dispatchEvent(eventArgs): void

• Dispatches an event in 3 phases:

  • Trickle-down: the event descends the hierarchy, from the first interactable ancestor of the target to its parent
  • Target: the event is sent to the target
  • Bubble-up: the event ascends the hierarchy, from the target's parent to its first interactable ancestor

  The eventArgs.origin is not included in the propagation path and the dispatch starts at eventArgs.origin child.

  Parameters

  • eventArgs: DispatchableEventArgs

    The event arguments to dispatch.

  Returns void

getInteractableByCollider

• getInteractableByCollider(collider): Interactable

• Returns an Interactable by the collider attached to it. This is an optimization to reduce expensive getComponent calls.

  Parameters

  • collider: ColliderComponent

    The ColliderComponent to filter interactables by.

  Returns Interactable

  The interactable that matches the collider.

getInteractableBySceneObject

• getInteractableBySceneObject(sceneObject): Interactable

• Returns the interactable of the passed SceneObject.

  Parameters

  • sceneObject: SceneObject

    The SceneObject to filter interactables by.

  Returns Interactable

  The interactable that matches the scene object.

getInteractablesByTargetingMode

• getInteractablesByTargetingMode(targetingMode): Interactable[]

• Returns all interactables that are set to the passed targeting mode.

  Parameters

  • targetingMode: TargetingMode

    TargetingMode to filter interactables by

  Returns Interactable[]

  an array of interactables that match the targeting mode

getInteractorsByType

• getInteractorsByType(inputType): Interactor[]

• Returns all interactors of matching interactor type

  Parameters

  • inputType: InteractorInputType

    The InteractorInputType to filter interactors by.

  Returns Interactor[]

  An array of interactors that match the input type.

getTargetingInteractors

• getTargetingInteractors(): Interactor[]

• Returns all interactors that are currently targeting

  Returns Interactor[]

  An array of interactors that are targeting.

registerInteractable

• registerInteractable(interactable): void

• Adds an Interactable to the interaction manager's registry. This registry helps speed up calculations when raycasting objects in the scene.

  Parameters

  • interactable: Interactable

    The Interactable to register.

  Returns void

registerInteractor

• registerInteractor(interactor): void

• Adds an Interactor to the interaction manager's registry, so it can be used to determine which {interactors} are interacting with interactables.

  Parameters

  • interactor: Interactor

    The Interactor to register.

  Returns void