Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Current state associated with a party
| Name | FOnlineParty |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlinePartyInterface.h |
| Include Path | #include "Interfaces/OnlinePartyInterface.h" |
Syntax
class FOnlineParty : public TSharedFromThis< FOnlineParty >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FOnlineParty
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnlineParty () |
Interfaces/OnlinePartyInterface.h | ||
FOnlineParty
(
const TSharedRef< const FOnlinePartyId >& InPartyId, |
Interfaces/OnlinePartyInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineParty() |
Interfaces/OnlinePartyInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LeaderId | FUniqueNetIdPtr | Unique id of the leader | Interfaces/OnlinePartyInterface.h | |
| PartyId | TSharedRef< const FOnlinePartyId > | Unique id of the party | Interfaces/OnlinePartyInterface.h | |
| PartyTypeId | const FOnlinePartyTypeId | Type of party (e.g., Primary) | Interfaces/OnlinePartyInterface.h | |
| PreviousState | EPartyState | The previous state of the party | Interfaces/OnlinePartyInterface.h | |
| RoomId | FChatRoomId | Id of chat room associated with the party | Interfaces/OnlinePartyInterface.h | |
| State | EPartyState | The current state of the party | Interfaces/OnlinePartyInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanLocalUserInvite
(
const FUniqueNetId& LocalUserId |
Check if the local user has invite permissions in this party. | Interfaces/OnlinePartyInterface.h | |
TSharedRef< const FPartyConfiguration > GetConfiguration() |
Get the party's configuration | Interfaces/OnlinePartyInterface.h | |
bool IsJoinable() |
Is this party joinable? | Interfaces/OnlinePartyInterface.h | |
virtual void SetState
(
EPartyState InState |
Interfaces/OnlinePartyInterface.h |