We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Interface IMixedRealityTeleportSystem

    Manager interface for a Teleport system in the Mixed Reality Toolkit All replacement systems for providing Teleportation functionality should derive from this interface

    Inherited Members
    IMixedRealityEventSystem.EventListeners
    IMixedRealityEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)
    IMixedRealityEventSystem.Register(GameObject)
    IMixedRealityEventSystem.Unregister(GameObject)
    IMixedRealityEventSystem.RegisterHandler<T>(IEventSystemHandler)
    IMixedRealityEventSystem.UnregisterHandler<T>(IEventSystemHandler)
    IMixedRealityService.Name
    IMixedRealityService.Priority
    IMixedRealityService.ConfigurationProfile
    IMixedRealityService.Initialize()
    IMixedRealityService.Reset()
    IMixedRealityService.Enable()
    IMixedRealityService.Update()
    IMixedRealityService.LateUpdate()
    IMixedRealityService.Disable()
    IMixedRealityService.Destroy()
    Namespace: Microsoft.MixedReality.Toolkit.Teleport
    Assembly: cs.temp.dll.dll
    Syntax
    public interface IMixedRealityTeleportSystem : IMixedRealityEventSystem, IMixedRealityService, IDisposable

    Properties

    TeleportDuration

    The duration of the teleport in seconds.

    Declaration
    float TeleportDuration { get; set; }
    Property Value
    Type Description
    Single

    Methods

    RaiseTeleportCanceled(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

    Raise a teleportation canceled event.

    Declaration
    void RaiseTeleportCanceled(IMixedRealityPointer pointer, IMixedRealityTeleportHotSpot hotSpot)
    Parameters
    Type Name Description
    IMixedRealityPointer pointer

    The pointer that raised the event.

    IMixedRealityTeleportHotSpot hotSpot

    The teleport target

    RaiseTeleportRequest(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

    Raise a teleportation request event.

    Declaration
    void RaiseTeleportRequest(IMixedRealityPointer pointer, IMixedRealityTeleportHotSpot hotSpot)
    Parameters
    Type Name Description
    IMixedRealityPointer pointer

    The pointer that raised the event.

    IMixedRealityTeleportHotSpot hotSpot

    The teleport target

    RaiseTeleportStarted(IMixedRealityPointer, IMixedRealityTeleportHotSpot)

    Raise a teleportation started event.

    Declaration
    void RaiseTeleportStarted(IMixedRealityPointer pointer, IMixedRealityTeleportHotSpot hotSpot)
    Parameters
    Type Name Description
    IMixedRealityPointer pointer

    The pointer that raised the event.

    IMixedRealityTeleportHotSpot hotSpot

    The teleport target

    Back to top Generated by DocFX