@relu-interactives/spatial-ecs
@relu-interactives/spatial-ecs / components / VRTeleportAreaComponent
Class: VRTeleportAreaComponent ​
Defined in: components/VRTeleportArea.ts:28
Marks an entity's surface as a valid teleport destination.
Teleport is an allow-list, not a physics query: only entities carrying an enabled area can be teleported onto. That keeps destinations deliberate — authors decide where the player may stand rather than discovering that every collider in the scene is walkable.
Extends ​
Constructors ​
Constructor ​
ts
new VRTeleportAreaComponent(options?): VRTeleportAreaComponent;Defined in: components/VRTeleportArea.ts:38
Parameters ​
| Parameter | Type |
|---|---|
options? | VRTeleportAreaOptions |
Returns ​
VRTeleportAreaComponent
Overrides ​
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
enabled | boolean | Whether this area currently accepts teleports. | components/VRTeleportArea.ts:30 |
shape | VrTeleportShape | Footprint shape. | components/VRTeleportArea.ts:32 |
width | number | Full width in metres (diameter for circle). | components/VRTeleportArea.ts:34 |
depth | number | Full depth in metres (unused for circle). | components/VRTeleportArea.ts:36 |