Skip to main content
Version: 4.24

Online Chat Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnChatRoomCreated‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
bool 
const FString& 
OnChatRoomConfigured‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
bool 
const FString& 
OnChatRoomJoinPublic‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
bool 
const FString& 
OnChatRoomJoinPrivate‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
bool 
const FString& 
OnChatRoomExit‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
bool 
const FString& 
OnChatRoomMemberJoin‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
const FUniqueNetId& 
OnChatRoomMemberExit‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
const FUniqueNetId& 
OnChatRoomMemberUpdate‚úĒDetailsconst FUniqueNetId&¬†
const FChatRoomId& 
const FUniqueNetId& 
OnChatRoomMessageReceived Detailsconst FUniqueNetId& 
const FChatRoomId& 
const TSharedRef<FChatMessage>& 
OnChatPrivateMessageReceived Detailsconst FUniqueNetId& 
const TSharedRef<FChatMessage>& 

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
CreateRoom Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
const FString& Nickname
const FChatRoomConfig& ChatRoomConfig
ConfigureRoom Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
const FChatRoomConfig& ChatRoomConfig
JoinPublicRoom Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
const FString& Nickname
const FChatRoomConfig& ChatRoomConfig
JoinPrivateRoom Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
const FString& Nickname
const FChatRoomConfig& ChatRoomConfig
ExitRoom‚úĒDetailsconst FUniqueNetId&¬†UserId
const FChatRoomId& RoomId
SendRoomChat‚úĒDetailsconst FUniqueNetId&¬†UserId
const FChatRoomId& RoomId
const FString& MsgBody
SendPrivateChat‚úĒDetailsconst FUniqueNetId&¬†UserId
const FUniqueNetId& RecipientId
const FString& MsgBody
IsChatAllowed‚úĒDetailsconst FUniqueNetId&¬†UserId
const FUniqueNetId& RecipientId
GetJoinedRooms‚úĒDetailsconst FUniqueNetId&¬†UserId
TArray<FChatRoomId>& OutRooms
GetRoomInfo Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
GetMembers Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
TArray<TSharedRef<FChatRoomMember>>& OutMembers
GetMember Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
const FUniqueNetId& MemberId
GetLastMessages Detailsconst FUniqueNetId& UserId
const FChatRoomId& RoomId
int32 NumMessages
TArray<TSharedRef<FChatMessage>>& OutMessages
IsMessageFromLocalUser Detailsconst FUniqueNetId& UserId
const FChatMessage& Message
const bool bIncludeExternalInstances
DumpChatState‚úĒDetails