ποΈ Globals and Constants
Use built-in constants, environment flags, and global references for math, platform checks, debugging, and core scene access.
ποΈ Global Functions
Use global utility functions for object management, scheduling, event messaging, and animations to create responsive and interactive behaviors.
ποΈ AccelerometerInput
The AccelerometerInput class provides methods to capture and manage accelerometer input from the device.
ποΈ AIAgentElement
Learn how to add and configure AI agents in your scene. This element supports multiple providers, custom prompts, model selection, and memory options for creating interactive, intelligent behaviors.
ποΈ AmbientLightElement
Learn how to use ambient light to provide uniform, shadow-free illumination across your scene, with adjustable color and intensity settings.
ποΈ AudioElement
Learn how to add audio sources to your scene with playback controls, looping, spatial proximity, and network synchronization for immersive sound design.
ποΈ AudioZoneElement
Learn how to define spatial audio zones with distance attenuation, directional cones, and transition events to create realistic 3D soundscapes.
ποΈ BoxColliderElement
Learn how to use box-shaped colliders for collision detection, boundaries, and walkable surfaces to control navigation and interactions in your scene.
ποΈ Canvas
Learn how to create, manage, and convert HTML canvas elements with utilities for 2D/WebGL rendering and image export.
ποΈ BatteryStatus
Access device information such as operating system, mobile detection, and battery status to adapt features and optimize user experiences.
ποΈ DirectionalLightElement
Learn how to add directional light sources to simulate sunlight or distant lighting, with customizable color, intensity, and shadow settings.
ποΈ GroundPlaneElement
Learn how to add a ground plane as a navigable floor or base terrain, with customizable color and walkability options.
ποΈ GroupElement
Use groups to organize scene elements, apply shared transformations, and manage multiple objects as a single unit.
ποΈ GyroscopeInput
Learn how to capture and manage gyroscope data from supported devices to track orientation and motion in your scene.
ποΈ Haptics
The Haptics class provides simple static methods for controlling device vibrations through the Vibration API
ποΈ HemisphereLightElement
The HemisphereLightElement class represents a non-directional light source that simulates natural illumination from both the sky and the ground. It provides soft, ambient lighting without harsh shadows, making it ideal for outdoor or environment lighting setups.
ποΈ RequestOptions
The RequestOptions interface lets you configure HTTP requests with headers, payloads, retries, and timeouts, while the HttpRequest class provides convenient static methods for sending requests (GET, POST, PUT, PATCH, HEAD, DELETE) using those options.
ποΈ ImageElement
The ImageElement class represents a 2D image in the scene with support for billboarding, hyperlinks, alpha transparency, projection modes, and optional network synchronization.
ποΈ KeyboardInput
The KeyboardInput class provides a static interface for handling keyboard events. It lets you start and stop input capture, query currently pressed keys, detect key releases, and check if a key has been held for a specific duration.
ποΈ Logger
The Logger class offers a straightforward logging system with multiple log levels (log, info, warn, error). It can be enabled or disabled globally, making it useful for debugging during development and silencing logs in production.
ποΈ MediaFrameElement
The MediaFrameElement class represents a flexible container for displaying various media types, including images, videos, 3D models, and PDFs. It supports customizable media types and optional network synchronization for shared playback and interactions.
ποΈ MirrorElement
The MirrorElement class defines a reflective surface within the scene. It supports customizable tint colors, allowing mirrors to range from neutral reflections to stylized, colored surfaces.
ποΈ ModelElement
The ModelElement class represents a 3D model within the scene. It supports billboard mode, networking, walkable surfaces, and animation control via THREE.AnimationMixer, making it suitable for interactive and dynamic 3D content.
ποΈ MouseInput
The MouseInput class provides a static interface for handling mouse events. It supports button press/release detection, tracking cursor position, reading scroll wheel deltas, and performing raycasts for object interaction.
ποΈ ObjectPool
The ObjectPool class manages object pooling, enabling efficient reuse of objects to reduce performance costs from frequent creation and destruction. It supports custom creation logic, dynamic resizing, and pool management utilities like acquiring, releasing, and shuffling objects.
ποΈ PDFElement
The PDFElement class represents an embedded PDF viewer within the scene. It supports loading documents from a file or URL and can optionally synchronize state and interactions across networked clients.
ποΈ Persistable
The Persistable class provides persistent keyβvalue storage tied to scene elements. It supports reading, writing, deleting, and clearing data, as well as advanced operations like numeric updates, array manipulation, locking, TTLs, and complete removal of stored objects.
ποΈ PointLightElement
The PointLightElement class defines a point light that radiates in all directions from a single source. It supports configurable color, intensity, range, and detailed shadow settings, making it suitable for localized lighting and realistic shadow effects.
ποΈ PrimitiveMeshElement
The PrimitiveMeshElement class represents a procedural 3D mesh based on configurable primitive geometry. It supports customizable colors, geometry types, parameters, and optional network synchronization for shared environments.