@needle-tools/engine/lib/engine-components/webxr/TeleportTarget.d.ts

Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.

import { Behaviour } from "../Component.js";
/**
 * Marks a GameObject as a valid teleportation target for VR locomotion.
 * Add this component to objects or surfaces where users should be able to teleport.
 *
 * **Usage:**
 * - Add to floor surfaces, platforms, or designated teleport spots
 * - Works with {@link XRControllerMovement} component's teleport system
 * - Can be used to restrict teleportation to specific areas
 *
 * **Setup:**
 * 1. Add this component to GameObjects that should be teleport destinations
 * 2. Configure {@link XRControllerMovement} to use teleport targets (optional)
 * 3. Test teleportation in VR mode
 *
 * @example
 * ```ts
 * // Make a platform teleportable
 * const platform = myPlatform.addComponent(TeleportTarget);
 * ```
 *
 * @summary Marker component for valid VR teleportation destinations
 * @category XR
 * @group Components
 * @see {@link XRControllerMovement} for VR locomotion and teleport configuration
 * @see {@link WebXR} for general WebXR setup
 */
export declare class TeleportTarget extends Behaviour {
}