Notification System

The Convai plugin comes with default notifications, totaling four. Here they are:


Not Close Enough to the Character

Appears when you press the talk button but there is no active NPC nearby.

Talk Button Released Early

Appears if you release the talk button in less than 0.5 seconds.

Microphone Issue Detected

Appears when the recorded audio input level is below the threshold.

Connection Problem

Appears when there is no internet connection upon launching the application.

How to Add Your Own Notification?

Adding your custom notification is straightforward.

Let's go through the steps to add a " CharacterStartedListening" notification as an example.

  1. Open the script "Convai/Scripts/Notification System/Notification Type.cs." This script stores Notification Types as enums. Give a name to your desired Notification type and add it here.

  1. Right-click on "Convai / Scripts / Notification System / Scriptable Objects" and select "Create > Convai > Notification System > Notification" then create a "Notification Scriptable Object".

  1. Name the created Notification Scriptable Object. Click on it, and fill in the fields in the Inspector as desired.

  1. Add the created Notification Scriptable Object to "Convai/Scripts/Notification System/Scriptable Objects" under "Convai Default Notification Group" (details of Notification Group here****).

  1. Your Notification is now ready. The last step is to call this Notification from where you need it. For example, if you created the " CharacterStartedTalking " Notification, find the location where your character listens and write the code.

  1. Replace the parameter with the NotificationType you created. (For our example, NotificationType.CharacterStartedListening)

  2. Ensure that the Convai Notification System is present in your scene. (accessible from "Convai/Prefabs/ Notification System")

All steps are complete, and you're ready to test!🙂✅

Notification Scriptable Object

This Scriptable Object stores information about a Notification

  • Notification Type

  • Notification Icon

  • Notification Title

  • Notification Message

To create a new Notification Scriptable Object, right-click anywhere in the Project Window and select "Create > Convai > Notification System > Notification"

Notification Group Scriptable Object

This Scriptable Object stores Notification Scriptable Objects as groups. When a Notification is requested, it searches for the Notification using the specified Notification Group in the Convai Notification System prefab's Notification System Handler script.

You can create different Notification groups based on your needs. Note: If your referenced Notification Group does not have the Notification you want, that Notification won't be called.

The Convai Default Notification Group has four Notifications, but you can add more or create a new group with additional notifications.

Last updated