> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata.md).

# Scene metadata

Scene metadata is how you give Convai characters awareness of the objects in your level. Add a `UConvaiObjectComponent` to any `Actor` — a door, a crate, a terminal — and every character in the level will know that object exists, what it is called, and what it does. Characters use this information when players ask about the environment around them.

For runtime mutations — adding objects, removing actors, setting conversation partners, and controlling attention — use the environment API on `UConvaiChatbotComponent`. See [Managing the environment at runtime](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/managing-the-environment-at-runtime.md) for the full method reference.

When the player looks at tagged objects, the [Gaze attention](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention.md) system can promote them to the chatbot's current focus automatically. Complete scene metadata setup first, then follow [Gaze attention quick start](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-quick-start.md).

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>How scene metadata works</strong><br>Understand object identity, tracked properties, proximity state, and the runtime sync pipeline.</td><td><a href="/pages/ct7GZc4pJVR5cE2Nx02x">/pages/ct7GZc4pJVR5cE2Nx02x</a></td></tr><tr><td><strong>Scene metadata quick start</strong><br>Tag a world actor with the Convai Object Component and test whether a character can use it in conversation.</td><td><a href="/pages/wMA4p35fTyTTaaCVW5Iq">/pages/wMA4p35fTyTTaaCVW5Iq</a></td></tr><tr><td><strong>Scene metadata component reference</strong><br>Full property, function, and event reference for the Convai Object Component.</td><td><a href="/pages/D7AS0tddjNnZ6oTWwtlC">/pages/D7AS0tddjNnZ6oTWwtlC</a></td></tr><tr><td><strong>Managing the environment at runtime</strong><br>Add, remove, and update world actors in a chatbot's environment during gameplay.</td><td><a href="/pages/0IWX9Z34917gjSpzDUY8">/pages/0IWX9Z34917gjSpzDUY8</a></td></tr><tr><td><strong>Scene metadata usage examples</strong><br>Complete setups for medical training, industrial safety drills, military simulations, and runtime environment updates.</td><td><a href="/pages/4fgSEKKPL6fKko07SAoV">/pages/4fgSEKKPL6fKko07SAoV</a></td></tr><tr><td><strong>Troubleshoot scene metadata</strong><br>Diagnose and fix common problems with scene objects not being recognized or tracked properties failing to update.</td><td><a href="/pages/vDCzfp22bc2x6dppbHkD">/pages/vDCzfp22bc2x6dppbHkD</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
