Portal
Supported Object types: 3d. Attach this component where needed. An Object has at most one instance of this component.
Use Object components to understand definitions and instance overrides.
A portal uses a named model surface and pairs two endpoints. A working view requires matching Pair names, opposite endpoints, and valid target surfaces; traversal also requires an eligible traveler.
Defaults below are normalized factory values from the component schema. Object presets, dimension, project units, and Scene overrides can supply different starting values. “Not stored” means the path is optional or runtime-derived. Read the property description to interpret it. Blank resource references assign no resource.
Writable means exposed for property writes through Logic. A No entry can still be editable in the Object Editor; runtime-only values cannot be authored. World-space lengths use metres, screen-space lengths use pixels, and rotations use degrees unless stated otherwise. The current loader refuses pixel-era projects. Use Units and Coordinates when comparing values.
| Property and path | Type | Factory default | Behavior | Writable |
|---|---|---|---|---|
| Enabled (enabled) | boolean | true | Whether this portal renders and can participate in traversal. | Yes |
| Target Model (target) | text | “model3d” | Named 3D Model component providing the portal surface. | No |
| Pair (pair) | text | “Portal 1” | Pair name shared by the two portal endpoints. Each pair needs matching endpoints. | Yes |
| Endpoint (endpoint) | text | “A” | Endpoint identity: A or B. Opposite endpoints with the same Pair connect. | Yes |
| Front Axis (forwardAxis) | text | “+z” | Axis defining the portal front: +x, -x, +y, -y, +z, or -z. | Yes |
| Aperture Width (width) | number | 0 | Aperture width in metres. 0 derives width from the target model bounds. | Yes |
| Aperture Height (height) | number | 0 | Aperture height in metres. 0 derives height from the target model bounds. | Yes |
| Offset X (offset.x) | number | 0 | Horizontal local aperture offset in metres. | Yes |
| Offset Y (offset.y) | number | 0 | Local aperture offset on Y in metres. | Yes |
| Offset Z (offset.z) | number | 0 | Local aperture offset on Z in metres. | Yes |
| Traversal (traversal) | boolean | true | Allows eligible travelers to move through the portal. Disabling traversal can preserve its visual view. | Yes |
| Traveler Object (traveler) | text | “” | Traveler Object restriction. Blank leaves no named Object restriction. | Yes |
| Render Quality (quality) | text | “auto” | Portal render-quality setting. auto uses the renderer’s automatic choice. | Yes |
| Render Distance (renderDistance) | number | 160 | Portal rendering distance in metres. Larger distances can include more scene content. | Yes |
| Streaming Radius (streamRadius) | number | 48 | Radius in metres requested for streamed content around the portal destination. | Yes |
| Exit Padding (exitPadding) | number | 0.4 | Padding in metres at the exit. Helps prevent an immediate reverse traversal. | Yes |
| Two Sided (twoSided) | boolean | false | Allows the portal surface to render from both sides. | Yes |
| Flip Horizontal (textureFlipU) | boolean | false | Reflects the portal view horizontally. | Yes |
| Flip Vertical (textureFlipV) | boolean | true | Reflects the portal view vertically. | Yes |
Myth Engine Documentation