Dynamic context

Find guides for sending live scene state to Convai characters through the dynamic context relay, scripting API, and synced world-object properties.

Dynamic context gives Convai characters real-time awareness of what is happening in a Unity scene. A character can reference a trainee's current station, an item recently picked up, or an alarm that fired, and weave that information into dialogue as it happens. Two entry points write to the same tracked state and produce identical network behavior: the ConvaiDynamicContextRelay Inspector component for event-driven bindings, and the DynamicContext property on ConvaiCharacter for code-driven systems.

How dynamic context works Understand the tracked state and event model, batching behavior, and how acknowledgement results reach your code.

Dynamic context quick start Add ConvaiDynamicContextRelay to an NPC and verify context-aware dialogue in a few steps.

Relay component reference Field-by-field reference for ConvaiDynamicContextRelay and the ConvaiRespondMode values it accepts.

Static context at connection time Configure initial dynamic info sent once at connection for facts that do not change during a session.

Sync behavior and timing How Replace, Append, and Reset messages batch and flush, including the DynamicContextBatchDelaySeconds window.

Dynamic context scripting API Full API reference for ConvaiCharacter.DynamicContext, including every method and the ConvaiRespondMode enum.

Dynamic context usage examples End-to-end scenarios covering safety drills, onboarding, guided tours, and synced world-object tracking.

Troubleshoot dynamic context Investigation checklist, symptom table, and Console log reference for the relay and tracker flow.

Synced world-object context

A ConvaiObjectMetadata component can expose tracked properties on a scene object. Each tracked property maps to a dynamic context state that every connected character receives automatically, without an explicit SetState call in your code. See Scene metadata for how to register objects and configure tracked properties.

Next steps

Start with Dynamic context quick start to get context-aware dialogue running. Then read How dynamic context works to understand the tracked state and event model before moving into the reference pages.