Scripts and documentation

script_list

List the saved Play scripts in the open Project.

Example prompt

“Which scripts are saved in this Project?”

Example response

{
  "scripts": [
    {
      "id": "SCRIPT_EXAMPLE",
      "name": "Welcome",
      "language": "TYPESCRIPT"
    }
  ]
}

NOTE: Use a returned script ID to read or update that script.

‍

script_read

Read the code in a saved Play script.

Example prompt

“Show the code in the Welcome script.”

Example response

{
  "id": "SCRIPT_EXAMPLE",
  "name": "Welcome",
  "language": "TYPESCRIPT",
  "content": "const button = Scene.getItem(\"start_button\") as Cuboid;\nbutton.input.onClick(() => { button.speech = \"Welcome\"; });"
}

NOTE: "content" contains the saved code. Reading it does not run the scene.

‍

script_create_or_update

Validate and save a TypeScript script for Play mode.

Example prompt

“Create a script called Welcome that makes start_button say Welcome when clicked.”

Example response

{
  "projectId": "PROJECT_EXAMPLE",
  "scriptId": "SCRIPT_EXAMPLE",
  "name": "Welcome",
  "language": "TYPESCRIPT",
  "created": true
}

NOTE: "created" is false when updating a script. Press Play in Delightex Nova to try the interaction.

‍

docs_search

Search Delightex Nova's scene-building and scripting documentation.

Example prompt

“Find Delightex Nova documentation about click interactions.”

Example response

{
  "hits": [
    {
      "path": "/play-mode/item-interactions",
      "title": "Object interaction recipe",
      "description": "Click/hover feedback and collision reactions on scene items.",
      "breadcrumb": "Recipe: object interaction > Click an item and show feedback",
      "excerpt": "button.input.onClick(() => {\n  button.speech = \"Started\";"
    }
  ],
  "truncated": false
}

NOTE: "hits" contains matching excerpts and paths. The assistant can use docs_read to read a complete page. Up to 10 matches are returned.

‍

docs_read

Read selected Delightex Nova documentation pages.

Example prompt

“Read the object interaction recipe.”

Example response

{
  "docs": [
    {
      "path": "/play-mode/item-interactions",
      "title": "Object interaction recipe",
      "description": "Click/hover feedback and collision reactions on scene items.",
      "content": "[Full documentation text]"
    }
  ]
}

NOTE: "content" contains the full Markdown page; its value is a placeholder here. Read up to five paths together, or request the documentation index.

‍

Tool index · About these examples