UxrTeleportSpawnCollider Class

Component that, added to an object with colliders, allows to define volumes that force a fixed teleportation destination when they are hit with teleporting pointers (arc, ray, etc.).

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrTeleportSpawnCollider)
              UltimateXR.Locomotion.UxrTeleportSpawnCollider
Namespace: UltimateXR.Locomotion
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

public class UxrTeleportSpawnCollider : UxrComponent<UxrTeleportSpawnCollider>

The UxrTeleportSpawnCollider type exposes the following members.

Constructors

	Name	Description
	UxrTeleportSpawnCollider

Properties

	Name	Description
	EnableWhenSelected	Gets or sets the GameObject that will be enabled while the component is being pointed at. This can be used to enable graphics that help identifying the interactivity and destination.

Methods

	Name	Description
	GetSpawnPos	If there are two spawn positions (one side and other side) it will return the farthest one to the avatar. This is useful to simulate ladders and other spawn elements that will allow to go from one side to the other. Otherwise it will just return the single spawn position.

Events

	Name	Description
	Teleported	Event raised when the user was teleported by using the spawn collider.

Extension Methods

	Name	Description
	CheckSetEnabled	Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
	GetOrAddComponent<T>	Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
	GetPathUnderScene	Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
	GetSceneUid	Gets an unique identifier string for the given component. (Defined by ComponentExt.)
	GetUniqueScenePath	Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
	LoopCoroutine	Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
	SafeGetComponentInParent<T>	Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
	ShowInInspector(Boolean)	Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
	ShowInInspector(Boolean, Boolean)	Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)