Skip to main content

UI Guide

ElysChat provides base C++ widget classes that you extend in Blueprint for your game's visual style.

Chat Widget

Inherit from UERPChatWidgetBase in Blueprint:

// In your HUD
UERPChatWidgetBase* ChatWidget = CreateWidget<UERPChatWidgetBase>(this, WBP_MyChatWidget);
ChatWidget->InitializeChatWidget(PlayerController->FindComponentByClass<UERPChatComponent>());
ChatWidget->AddToViewport();

Blueprint Events

EventDescription
OnMessageReceivedNew message to display
OnChannelChangedActive channel switched
OnAutoCompleteSuggestionsUpdatedNew autocomplete suggestions

Formatting

// Format message using channel template
FString Formatted = ChatWidget->FormatMessageForDisplay(Message);

// Get channel color
FLinearColor Color = ChatWidget->GetMessageColor(Message);

Speech Bubbles

Add UERPChatBubbleComponent to your character:

// Auto-billboards toward camera
ChatBubble->ShowMessage(FormattedMessage);
ChatBubble->DisplayDuration = 5.0f;
ChatBubble->MaxQueuedMessages = 3;

Input History

Navigate previous inputs with arrow keys:

FString Previous = ChatComponent->GetPreviousInput();  // Arrow Up
FString Next = ChatComponent->GetNextInput(); // Arrow Down

Ring buffer of up to 20 entries.