/
Scenes and capture

Scenes and capture

scene_get_info

Inspect the active scene and its object hierarchy.

Example prompt

“Show the objects in the active scene.”

Example response

{
  "scene": {
    "id": "SCENE_EXAMPLE",
    "name": "Garden",
    "mainCamera": "Camera",
    "itemCount": 2,
    "rootItemCount": 2,
    "itemCountsByType": {
      "camera": 1,
      "cuboid": 1
    }
  },
  "items": [
    {
      "name": "Camera",
      "type": "camera"
    },
    {
      "name": "Box",
      "type": "cuboid"
    }
  ]
}

NOTE: Large scenes may be shortened. The assistant can inspect a named object's children or request more items.

‍

scene_get_item_details

Read a selected object's placement, appearance, and behavior settings.

Example prompt

“Inspect the object named Box.”

Example response

{
  "items": [
    {
      "name": "Box",
      "type": "cuboid",
      "active": true,
      "transform": {
        "world": {
          "position": [0.0, 0.0, 0.5],
          "forward": [0.0, 1.0, 0.0],
          "up": [0.0, 0.0, 1.0],
          "scale": 1.0
        }
      },
      "bounds": {
        "center": [0.0, 0.0, 0.5],
        "size": [1.0, 1.0, 1.0]
      },
      "color": "#FF0000",
      "opacity": 1.0,
      "nameVisible": false,
      "physicsEnabled": false,
      "geometry": {
        "size": [1.0, 1.0, 1.0]
      }
    }
  ]
}

NOTE: Use exact names from scene_get_info. Up to 20 objects can be inspected together; returned details vary by object type.

‍

scene_apply_action

Create, duplicate, rename, reorder, or switch scenes.

Example prompt

“Rename the active scene to Night Garden.”

Example response

{
  "changed": true,
  "scenes": [
    {
      "id": "SCENE_EXAMPLE",
      "name": "Night Garden",
      "active": true
    }
  ]
}

NOTE: One action runs at a time. The returned scene list shows which scene is active.

‍

scene_delete

Delete a scene from the open Project.

Example prompt

“Delete the scene named Draft.”

Example response

{
  "scenes": [
    {
      "id": "SCENE_EXAMPLE",
      "name": "Garden",
      "active": true
    }
  ]
}

NOTE: Returns the remaining scenes. The last scene cannot be deleted.

‍

scene_list_environments

List environments available for the active scene.

Example prompt

“Which environments can I use in this scene?”

Example response

{
  "environments": [
    {
      "id": "ENVIRONMENT_EXAMPLE",
      "description": "Example landscape"
    }
  ]
}

NOTE: The assistant uses the returned ID when changing the environment.

‍

scene_builder_run

Apply scene edits immediately using code written by the assistant.

Example prompt

“Add a red cube named Box at the center of this scene.”

Example response

{
  "projectId": "PROJECT_EXAMPLE",
  "logs": "",
  "changed": true,
  "createdItems": 1,
  "deletedItems": 0
}

NOTE: The result reports whether the scene changed and how many objects were created or deleted. It does not save a Play script.

‍

scene_take_screenshot

Capture the current view or a temporary camera angle as a PNG.

Example prompt

“Take a 1024 by 768 screenshot of the current view.”

Example response

{
  "width": 1024,
  "height": 768
}

NOTE: The tool also returns the PNG image separately. The JSON contains its dimensions; the scene and editor view stay unchanged.

‍

scene_record_video

Run the active scene in Play mode and record a video.

Example prompt

“Record a 10-second portrait video in Full HD.”

Example response

{
  "downloadUrl": "https://downloads.example/scene-video.mp4",
  "mimeType": "video/mp4",
  "sizeBytes": 2457600
}

NOTE: Videos are silent; download links are temporary. HD/Full HD allow 1–60 seconds, and 4K allows 1–30. General gameplay control is unavailable.

‍

Tool index · About these examples

Browse by topic
Get help