Scene metadata

Find guides, reference pages, and examples for giving Convai characters awareness of objects in your Unreal Engine level.

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 for the full method reference.

When the player looks at tagged objects, the Gaze attention system can promote them to the chatbot's current focus automatically. Complete scene metadata setup first, then follow Gaze attention quick start.

How scene metadata works Understand object identity, tracked properties, proximity state, and the runtime sync pipeline.

Scene metadata quick start Tag a world actor with the Convai Object Component and test whether a character can use it in conversation.

Scene metadata component reference Full property, function, and event reference for the Convai Object Component.

Managing the environment at runtime Add, remove, and update world actors in a chatbot's environment during gameplay.

Scene metadata usage examples Complete setups for medical training, industrial safety drills, military simulations, and runtime environment updates.

Troubleshoot scene metadata Diagnose and fix common problems with scene objects not being recognized or tracked properties failing to update.