Navigation
API > API/Plugins > API/Plugins/Party
Helper class for maintaining a single chat room at the game level
| Name | UChatroom |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/Chatroom.h |
| Include Path | #include "Chatroom.h" |
Syntax
UCLASS (MinimalAPI, Config=Game)
class UChatroom : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UChatroom
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UChatroom() |
Ctor | Chatroom.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChatRoomCreatedDelegateHandle | FDelegateHandle | OSS delegate handles | Chatroom.h | |
| ChatRoomLeftDelegateHandle | FDelegateHandle | Chatroom.h | ||
| ChatRoomRetryTimerHandle | FTimerHandle | Handle on chat room retry timer | Chatroom.h | |
| CurrentChatRoomId | FString | Current chat room associated with this object (FString so UPROPERTY works) | Chatroom.h | |
| MaxChatRoomRetries | int32 | Max number of retries before giving up on chat | Chatroom.h | |
| NumChatRoomRetries | int32 | Current number of retries on a chat room | Chatroom.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CreateOrJoinChatRoom
(
FUniqueNetIdRepl LocalUserId, |
Chat room functions Try to join a chat room by calling CreateRoom, will either create or join if it already exists | Chatroom.h | |
void LeaveChatRoom
(
const FUniqueNetIdRepl& LocalUserId, |
Leave the joined chat room | Chatroom.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTimerManager & GetTimerManager() |
Chatroom.h | ||
UWorld * GetWorld() |
Chatroom.h | ||
bool IsAlreadyInChatRoom
(
const FUniqueNetIdRepl& LocalUserId, |
Chatroom.h | ||
virtual bool IsOnline() |
Chatroom.h | ||
void UnregisterDelegates() |
Chatroom.h |