Pre-built UI Prefabs

Convai UI Prefabs - Utilize ready-to-use UI elements for Convai integration.

We provide several UI options to display character and user's transcript out of the box that players can use with the Convai Plugin. You can use and customize these prefabs.

The ConvaiNPC and ConvaiGRPCAPI scripts look for GameObjects with Convai Chat UI Handler as a component, and send any transcripts to the script so that it can be displayed on screen.

Types of UI

ChatBox

Prefab Name: Convai Transcript Canvas - Chat

Both the user's and the character's transcripts are displayed one after other in a scrollable chat box.

Subtitle

Prefab Name: Convai Transcript Canvas - Subtitle

The user and character transcripts are displayed in the bottom like subtitles.

Question-Answer

Prefab Name: Convai Transcript Canvas - QA

The user's transcript is displayed in the top where as the character's transcript is displayed in the bottom.

Mobile Optimised UI Styles

Prefab Name: Convai Transcript Canvas - Mobile Subtitle

Identical to Subtitle UI. Includes a button that can be pressed and held for the user to speak. Ideal for portrait orientation of screen.

Prefab Name: Convai Transcript Canvas - Mobile QA

Prefab Name: Convai Transcript Canvas - Mobile Chat

Convai Chat UI Handler Component

Functions to Know

SendCharacterText	A public function that sends a string of text to be displayed as character transcript along with the name of the character who said it.
SendUserText	A public function that sends a string of text to be displayed as user transcript.