> 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

Find verified Blueprint component, utility, audio, and shared data references for the Convai Unreal Engine plugin runtime workflow.

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="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-chatbot-component.md">Convai Chatbot Component</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="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-player-component.md">Convai Player Component</a></td></tr><tr><td><strong>Convai Object Component</strong><br>Properties, functions, and events for the world object tagging component, including tracked properties, movement awareness, and gaze callbacks.</td><td><a href="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-object-component.md">Convai Object Component</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="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/microphone-and-audio-capture.md">Microphone and audio capture</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="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-utility-functions.md">Convai utility functions</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="/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/data-types-and-enums.md">Data types and enums</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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
