Permanently delete entities and all descendants from a PlayCanvas scene. Irreversible destructive action; prefer modify_entities for hiding or remove_components for component removal.
Resolve entity names into resource IDs and hierarchy paths, enabling follow-up API calls without manually tracking UUIDs. Supports case-insensitive substring or exact name matching.
Retrieve assets from a PlayCanvas project using filters for type, name, or tag. Paginated responses provide compact summaries; use full mode for complete asset JSON when needed.
Read live entity state from the running Launch instance to verify play-mode behavior directly—positions, rotations, rigidbody velocities, and UI text—without guessing from screenshots.
Create a new branch in PlayCanvas and switch the editor to it. Fork from the current branch or optional source branch/checkpoint to isolate feature work and return the new branch's VCS status.
Create new entities and nested hierarchies in the current PlayCanvas scene, including cameras, lights, models, UI, or empty groups, and return their IDs inline for immediate reuse.
Update existing entities by setting or unsetting property values using dot-notation paths, with instant validation that lists valid paths to fix errors.
Capture a downscaled WebP screenshot of the live running PlayCanvas launch instance to visually verify play-mode behavior. Requires launch_start first.
Dispatch keyboard, mouse, or touch events to a running PlayCanvas Launch instance to drive end-to-end interactions like pressing keys, clicking buttons, or tapping the screen.
Permanently remove assets from a project by their IDs, deleting them and clearing any entity references. Use to clean up unused assets; to detach an asset without deleting it, modify entities instead.
Set multiple material attributes—diffuse, emissive, metalness, gloss, opacity, maps—in one request. Update only the specified fields to customize a material asset.
Update scene-wide physics and rendering settings: gravity, fog, ambient light, skybox, tonemapping, exposure, lightmapping. Only specified fields change; returns the full scene settings snapshot.
Retrieve the current scene-wide physics and rendering settings from the PlayCanvas Editor. Returns the complete settings object to inspect scene configuration without making changes.
Get current project-wide settings, including physics, rendering device, layers, loading screen, script loading order, input, resolution. Use it to inspect the full configuration without modifying it.