docs.unity3d.com
    Show / Hide Table of Contents

    Class TeleportationArea

    An area is a teleportation destination which teleports the user to their pointed location on a surface.

    Inheritance
    Object
    XRBaseInteractable
    BaseTeleportationInteractable
    TeleportationArea
    Inherited Members
    BaseTeleportationInteractable.teleportationProvider
    BaseTeleportationInteractable.matchOrientation
    BaseTeleportationInteractable.teleportTrigger
    BaseTeleportationInteractable.Awake()
    BaseTeleportationInteractable.OnSelectEntered(SelectEnterEventArgs)
    BaseTeleportationInteractable.OnSelectExited(SelectExitEventArgs)
    BaseTeleportationInteractable.OnActivated(ActivateEventArgs)
    BaseTeleportationInteractable.OnDeactivated(DeactivateEventArgs)
    XRBaseInteractable.registered
    XRBaseInteractable.unregistered
    XRBaseInteractable.interactionManager
    XRBaseInteractable.colliders
    XRBaseInteractable.interactionLayerMask
    XRBaseInteractable.customReticle
    XRBaseInteractable.firstHoverEntered
    XRBaseInteractable.lastHoverExited
    XRBaseInteractable.hoverEntered
    XRBaseInteractable.hoverExited
    XRBaseInteractable.selectEntered
    XRBaseInteractable.selectExited
    XRBaseInteractable.activated
    XRBaseInteractable.deactivated
    XRBaseInteractable.hoveringInteractors
    XRBaseInteractable.selectingInteractor
    XRBaseInteractable.isHovered
    XRBaseInteractable.isSelected
    XRBaseInteractable.Reset()
    XRBaseInteractable.OnEnable()
    XRBaseInteractable.OnDisable()
    XRBaseInteractable.OnDestroy()
    XRBaseInteractable.GetDistanceSqrToInteractor(XRBaseInteractor)
    XRBaseInteractable.IsHoverableBy(XRBaseInteractor)
    XRBaseInteractable.IsSelectableBy(XRBaseInteractor)
    XRBaseInteractable.AttachCustomReticle(XRBaseInteractor)
    XRBaseInteractable.RemoveCustomReticle(XRBaseInteractor)
    XRBaseInteractable.ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase)
    XRBaseInteractable.OnRegistered(InteractableRegisteredEventArgs)
    XRBaseInteractable.OnUnregistered(InteractableUnregisteredEventArgs)
    XRBaseInteractable.OnHoverEntering(HoverEnterEventArgs)
    XRBaseInteractable.OnHoverEntered(HoverEnterEventArgs)
    XRBaseInteractable.OnHoverExiting(HoverExitEventArgs)
    XRBaseInteractable.OnHoverExited(HoverExitEventArgs)
    XRBaseInteractable.OnSelectEntering(SelectEnterEventArgs)
    XRBaseInteractable.OnSelectExiting(SelectExitEventArgs)
    XRBaseInteractable.onFirstHoverEntered
    XRBaseInteractable.onLastHoverExited
    XRBaseInteractable.onHoverEntered
    XRBaseInteractable.onHoverExited
    XRBaseInteractable.onSelectEntered
    XRBaseInteractable.onSelectExited
    XRBaseInteractable.onSelectCanceled
    XRBaseInteractable.onActivate
    XRBaseInteractable.onDeactivate
    XRBaseInteractable.onFirstHoverEnter
    XRBaseInteractable.onHoverEnter
    XRBaseInteractable.onHoverExit
    XRBaseInteractable.onLastHoverExit
    XRBaseInteractable.onSelectEnter
    XRBaseInteractable.onSelectExit
    XRBaseInteractable.onSelectCancel
    XRBaseInteractable.OnHoverEntering(XRBaseInteractor)
    XRBaseInteractable.OnHoverEntered(XRBaseInteractor)
    XRBaseInteractable.OnHoverExiting(XRBaseInteractor)
    XRBaseInteractable.OnHoverExited(XRBaseInteractor)
    XRBaseInteractable.OnSelectEntering(XRBaseInteractor)
    XRBaseInteractable.OnSelectEntered(XRBaseInteractor)
    XRBaseInteractable.OnSelectExiting(XRBaseInteractor)
    XRBaseInteractable.OnSelectExited(XRBaseInteractor)
    XRBaseInteractable.OnSelectCanceling(XRBaseInteractor)
    XRBaseInteractable.OnSelectCanceled(XRBaseInteractor)
    XRBaseInteractable.OnActivate(XRBaseInteractor)
    XRBaseInteractable.OnDeactivate(XRBaseInteractor)
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public class TeleportationArea : BaseTeleportationInteractable

    Methods

    GenerateTeleportRequest(XRBaseInteractor, RaycastHit, ref TeleportRequest)

    Generates a teleport request.

    Declaration
    protected override bool GenerateTeleportRequest(XRBaseInteractor interactor, RaycastHit raycastHit, ref TeleportRequest teleportRequest)
    Parameters
    Type Name Description
    XRBaseInteractor interactor

    The interactor generating the teleport request.

    RaycastHit raycastHit

    The raycast hit where user will be teleported to.

    TeleportRequest teleportRequest

    The teleport request.

    Returns
    Type Description
    Boolean

    Returns true if button teleportation was successful. Otherwise, returns false.

    Overrides
    BaseTeleportationInteractable.GenerateTeleportRequest(XRBaseInteractor, RaycastHit, ref TeleportRequest)

    See Also

    TeleportationAnchor
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023