Text Chat
Text chat between the web and in event experience
Beta Quality - Customers are encouraged to test and use Beta features in their experiences, but may still require some support
Overview
The ability to chat on web and in game, including:
Chat from Web to Unreal and back
Works on Desktop and Mobile*
Text appears in game above the head
Ability to hide and show the widget, and custom sizing
User name and profile image appending to the message
The in-and-out-experience chat is backed by PubNub. For battle-tested, in-experience only chat, see Experience Only Chat.
* Mobile is currently only supported via the old chat UI (Cloud Chat). See Adding Mobile support to continue use of this version of the text chat for desktop
Integration
Make sure you have a safe internal launch context id set up for your editor users.
Configure the variable
Social.Chat.Editor.LaunchContextIdindeployment.jsonwith this value (see below)
How to enable
Enable
TextChat.UseCloudChatingame.json.Make sure your in-game HUD is set up to use the new chat system
The following settings in game.json influence the Text Chat feature:
Setting | Description | Default Value |
| Enables the cloud chat functionality | true |
| Forces mobile view regardless of detected platform | false |
The following deployment.json influence the Text Chat feature:
Setting | Description | Default Value |
| Determines how the client should determine the launch context id to use for chat. The values are as follows: “LiveConfigWorldId” (use the legacy M2.Domains.WorldId value) - this is how the previous system worked “LiveConfigChatLaunchContext” - a setting provided from live config (Social.Chat.LaunchContextId) “CommandLineLaunchContext” - use the -LaunchContextId command line argument the game was booted from (default behaviour if not set) | CommandLineLaunchContext (the game uses the commandline argument -LaunchContextId) |
| Use this launch context id for chat.
Only when Social.Chat.LaunchContextSource is set to LiveConfigChatLaunchContext) |
|
| Similar to Social.Chat.LaunchContextSource, but determine how the editor should find its chat launch context. | LiveConfigChatLaunchContext |
| Set this to a “known good” (safe/internal) launch context that should be used for chat in your project.
This is required for editor users to use chat. You can create one in the M2 Web Platform Admin UI
|
|
(LEGACY) | The launch context id in the web to scope the chat to.
This must match the web portals if you want cross-experience chat. |
|
Adding Chat to your HUD
Add WBP_M2_TextChat to your HUD and ensure it is stretched across the whole screen.
Adding Mobile Support
WBP_M2_TextChat does not yet support mobile platforms. If your HUD is or derives from WBP_TH_HUD then your good to go. Otherwise follow the below steps:
Use a widget switcher to switch between WBP_M2_TextChat and WBP_TextChatWindow_Mobile with the following code to allow it to automatically revert to the old UI for mobile devices.
On Bootflow finished, add a handle to get live config updates.
Create a function called Update Live Config and add the following:
Full Live Config Setting List
Settings marked (LEGACY) may be removed in a future update
| Setting | Description | Default Value |
|---|---|---|
| Enables the Global Chat channel | true |
| Enables use of the cloud based chat system, linking the in game chat with web chat | true |
| Forces the old Chat UI ( | false |
| Force the old Chat UI ( | false |
| Sets the chat interfaces to start in a minimized state | true |
| Enables the in game emoji menu to be used. Only supported in | true |
| Enables message reactions. Still WIP, not yet supported in Origin | false |
| Max messages to be displayed in the chat interface | 100 |
(LEGACY) | Enables Local chat functionality for Experience only chat | true |
(LEGACY) | Maximum number of messages a player can send per second | 10 |
(LEGACY) | Defines the message queue size for the local chat server | 100 |
(LEGACY) | Allows questions to be sent in chat | false |
Last updated
