UChatroom

Helper class for maintaining a single chat room at the game level

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Party

Header

/Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Chatroom.h

Include

#include "Chatroom.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Game)
class UChatroom : public UObject

Remarks

Helper class for maintaining a single chat room at the game level

Constructors

Name Description

Public function

UChatroom()

Ctor

Functions

Name Description

Public function

void

 

CreateOrJoinChatRoom

(
    FUniqueNetIdRepl LocalUserId,
    FChatRoomId ChatRoomId,
    FOnChatRoomCreatedOrJoined Completi...,
    FChatRoomConfig RoomConfig
)

Chat room functions Try to join a chat room by calling CreateRoom, will either create or join if it already exists

Protected function Const

FTimerManage...

 

GetTimerManager()

Protected function Const

UWorld *

 

GetWorld()

Protected function Const

bool

 

IsAlreadyInChatRoom

(
    const FUniqueNetIdRepl& LocalUserI...,
    const FChatRoomId& ChatRoomId
)

Protected function Virtual Const

bool

 

IsOnline()

Public function

void

 

LeaveChatRoom

(
    const FUniqueNetIdRepl& LocalUserI...,
    const FOnChatRoomLeft& CompletionD...
)

Leave the joined chat room

Protected function

void

 

UnregisterDelegates()
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss