> 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/blueprint-reference.md).

# Blueprint reference

The Blueprint reference documents the core runtime Blueprint surface for the Convai Unreal Engine plugin: the chatbot, player, and object components; shared structs and enums; microphone capture; and cross-cutting utility libraries. Use these pages when you need exact property names, function signatures, defaults, categories, and constraints.

Feature-specific Blueprint nodes — actions parameter accessors, dynamic context transport details, emotion helpers, long-term memory (LTM) nodes, vision, and narrative design — live in each feature's own Blueprint reference page. The **Convai Subsystem** connection surface is documented in [Session lifecycle](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/session-lifecycle.md), not here.

<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>Convai Chatbot Component</strong><br>Properties, functions, and events for the AI character component, including session, identity, lip sync, vision, and environment APIs.</td><td><a href="/pages/0VDwXeI6AzMabnJyekSQ">/pages/0VDwXeI6AzMabnJyekSQ</a></td></tr><tr><td><strong>Convai Player Component</strong><br>Properties, functions, and events for the player component, including identity, session, microphone capture, streaming, and gaze attention.</td><td><a href="/pages/qPgHSr8R4sd5rplgr5u4">/pages/qPgHSr8R4sd5rplgr5u4</a></td></tr><tr><td><strong>Convai Object Component</strong><br>Properties, functions, and events for the world object tagging component, including tracked properties, proximity state, and gaze callbacks.</td><td><a href="/pages/DkhdClgCqO2tHqAGtVFi">/pages/DkhdClgCqO2tHqAGtVFi</a></td></tr><tr><td><strong>Microphone and audio capture</strong><br>Microphone device structs, player-component capture functions, the audio capture component, and Android permission requirements.</td><td><a href="/pages/6BNXkLsA5NhP4cLsdovV">/pages/6BNXkLsA5NhP4cLsdovV</a></td></tr><tr><td><strong>Convai utility functions</strong><br>Blueprint libraries for look-at helpers, component lookups, settings accessors, blendshape tools, file I/O, and connection pre-warming.</td><td><a href="/pages/SZgrn5ikGQTQteegD5Hr">/pages/SZgrn5ikGQTQteegD5Hr</a></td></tr><tr><td><strong>Data types and enums</strong><br>Shared Blueprint structs and enums used across components, including object entries, action types, connection states, and VAD settings.</td><td><a href="/pages/gyOnm5SFuaK37xai5UZx">/pages/gyOnm5SFuaK37xai5UZx</a></td></tr></tbody></table>

### Feature Blueprint references

Use these pages for feature-specific nodes that extend the core component APIs:

| Feature           | Page                                                                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Character actions | [Actions Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/actions-blueprint-reference.md)                  |
| Dynamic context   | [Dynamic context Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-blueprint-reference.md)    |
| Emotion           | [Emotion Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-blueprint-reference.md)                            |
| Long-term memory  | [LTM Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/ltm-blueprint-reference.md)                           |
| Narrative design  | [Narrative design Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference.md) |
| Vision            | [Vision Blueprint reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-blueprint-reference.md)                               |
| Gaze attention    | [Gaze attention reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-reference.md)                           |
| Lip sync          | [Face Sync component reference](/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-component-reference.md)                       |


---

# 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/blueprint-reference.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.