Emotion Blueprint reference
Reference for emotion properties, functions, events, and enums on the Convai Chatbot component — including types, defaults, and parameter details.
The supported score-driven emotion Blueprint nodes and properties live on UConvaiChatbotComponent (displayed as Convai Chatbot in the Details panel and Components list). The enums EBasicEmotions and EEmotionIntensity are available throughout Blueprint wherever emotion values are used.
Properties
LockEmotionState
Type
bool
Category
Convai | Emotion
Access
BlueprintReadWrite, EditAnywhere
Replicated
Yes
Default
false
When true, incoming emotion updates from the server are discarded. On the server path, On Emotion State Changed does not fire while locked. Set to false to resume receiving server-driven emotion updates and events.
Force Set Emotion and Reset Emotion State still update state and fire the event while locked.
EmotionOffset
Type
float
Category
Convai
Access
BlueprintReadWrite, EditAnywhere
Default
0.0
Shifts all computed emotion scores by this amount when a server-driven update arrives, before scores are clamped to 0.0–1.0. The source comment describes a useful range of -1.0 to 1.0. A positive value amplifies perceived intensity; a negative value diminishes it. Does not apply to scores set via Force Set Emotion.
Functions
Force Set Emotion
Overrides the current emotion state from Blueprint without waiting for a server update. The score applied equals the EEmotionIntensity multiplier for the chosen level (see the EEmotionIntensity table). EmotionOffset is not applied.
BasicEmotion
EBasicEmotions
The emotion category to set
Intensity
EEmotionIntensity
Intensity level — determines the score multiplier applied
ResetOtherEmotions
bool
When true, zeros all other emotion scores first
Force Set Emotion fires On Emotion State Changed immediately after updating the state.
Get Emotion Score
Returns the current score for a single emotion category as a float in the range 0.0–1.0. Returns 0.0 if the emotion has no current score entry.
On the server path, scores are computed as server scale / 3 + EmotionOffset, clamped to 0.0–1.0. On the Force Set Emotion path, scores use the EEmotionIntensity multiplier instead.
Emotion
EBasicEmotions
The emotion category to query
Reset Emotion State
Zeros all emotion scores in EmotionState. Use this to return the character to a neutral expression — for example, at the end of a cutscene or when transitioning to a new scene.
Reset Emotion State fires On Emotion State Changed after zeroing the state.
Events
On Emotion State Changed
Display name
On Emotion State Changed
Type
BlueprintAssignable delegate
Category
Convai
Fires on the game thread when the emotion state is updated by the server (when LockEmotionState is false), by Force Set Emotion, or by Reset Emotion State. Bind to this event in the character's Blueprint to react to expression changes.
Does not fire for server-driven updates while LockEmotionState is true.
Signature:
Chatbot Component
UConvaiChatbotComponent*
The chatbot component whose emotion state changed
Interacting Player Component
UConvaiPlayerComponent*
Always null in the current plugin on every path (server-driven, Force Set Emotion, and Reset Emotion State). Null-check this pin before using it.
Enum reference
EBasicEmotions
Joy
Happy
Trust
Calm
Fear
Afraid
Surprise
Surprise
Sadness
Sad
Disgust
Bored
Anger
Angry
EEmotionIntensity
Enum value
Blueprint display name
Score multiplier (Force Set Emotion only)
LessIntense
Less Intense
0.25
Basic
Basic
0.60
MoreIntense
More Intense
1.00
These multipliers apply only when Force Set Emotion is called. Server-driven scores use server scale / 3 + EmotionOffset instead.
Related pages
How the emotion system worksEmotion examplesLast updated
Was this helpful?