Navigation
| Name | Party |
| Type | Plugin |
| Part of Plugins | Online Framework Plugin |
| Location | /Engine/Plugins/Online/OnlineFramework/Source/Party/ |
| Module Build Rules | Party.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FChannelChangeSlashCommand | |
| FChatSlashCommand | |
| FDesignerPreviewSocialUserChatMessage | |
| FFounderChannelSlashCommand | |
| FGlobalChannelSlashCommand | |
| FInteractionCommandWrapper | |
| FPartyChannelSlashCommand | |
| FPartyDataReplicatorHelper | Util exclusively for use by TPartyDataReplicator to circumvent circular include header issues (we can't include SocialParty.h or PartyMember.h here) |
| FPartyModule | Total async thread time Module for the party framework that builds on top of IOnlineParty |
| FRegisteredSlashCommands | Slash Command Component. |
| FReplySlashCommand | |
| FSocialChatMessage | Represents a single message sent within a chat channel |
| FSocialInteraction_AcceptFriendInvite | |
| FSocialInteraction_AcceptJoinRequest | |
| FSocialInteraction_AcceptPartyInvite | |
| FSocialInteraction_AddFriend | Core set of user/friend interactions supported by the Social framework |
| FSocialInteraction_AddPlatformFriend | |
| FSocialInteraction_Block | |
| FSocialInteraction_DismissJoinRequest | |
| FSocialInteraction_InviteToParty | Default Party interactions supported by the Social framework |
| FSocialInteraction_JoinParty | |
| FSocialInteraction_KickPartyMember | |
| FSocialInteraction_LeaveParty | |
| FSocialInteraction_PrivateMessage | |
| FSocialInteraction_PromoteToPartyLeader | |
| FSocialInteraction_RejectFriendInvite | |
| FSocialInteraction_RejectPartyInvite | |
| FSocialInteraction_RemoveFriend | |
| FSocialInteraction_RequestToJoinParty | |
| FSocialInteraction_ShowPlatformProfile | |
| FSocialInteraction_Unblock | |
| FSocialInteractionHandle | Represents a single discrete interaction between a local player and another user. |
| FSocialLocalChatMessage | A locally generated chat message that was not sent by a particular user. |
| FSocialQueryBase | |
| FSocialQueryManager | |
| FSocialSystemChatMessage | |
| FSocialUserChatMessage | A chat message that originated from a particular SocialUser - by far the most common type of message |
| FSocialUserListConfig | Configuration of ISocialUserList properties that are immutable once the list is created. |
| FTeamChannelSlashCommand | |
| TPartyDataReplicator | Base util class for dealing with data that is replicated to party members |
| TSocialInteractionWrapper | |
| TSocialQuery | |
| UChatroom | Helper class for maintaining a single chat room at the game level |
| UPartyMember | |
| USocialChatChannel | Base SocialCore chat channel class (partial ISocialChatChannel implementation) |
| USocialChatManager | The chat manager is a fully passive construct that watches for creation of chat rooms and message activity therein |
| USocialChatRoom | A multi-user chat room channel. |
| USocialDebugTools | |
| USocialGroupChannel | |
| USocialManager | Singleton manager at the top of the social framework |
| USocialParty | Party game state that contains all information relevant to the communication within a party Keeps all players in sync with the state of the party and its individual members |
| USocialPartyChatRoom | A multi-user chat room channel. |
| USocialPrivateMessageChannel | A modified version of a chat room that only contains two participants - the current user and a private recipient of their messages. |
| USocialReadOnlyChatChannel | A strawman chat channel that relies exclusively on other channels messages for content, does not support sending messages |
| USocialSettings | Config-driven settings object for the social framework. |
| USocialToolkit | Represents the full suite of social functionality available to a given LocalPlayer |
| USocialUser |
Structs
| Name | Remarks |
|---|---|
| FAutoCompleteStruct | |
| FJoinPartyResult | |
| FOnlinePartyRepDataBase | Base for all rep data structs |
| FPartyJoinApproval | |
| FPartyJoinDenialReason | Companion to EPartyJoinDenialReason to lessen the hassle of working with a "customized" enum |
| FPartyMemberJoinInProgressData | Join in progress data. |
| FPartyMemberJoinInProgressRequest | Join in progress request. |
| FPartyMemberJoinInProgressResponse | Join in progress response. |
| FPartyMemberPlatformData | Platform data fields for party replication |
| FPartyMemberRepData | Base struct used to replicate data about the state of a single party member to all members. |
| FPartyPlatformSessionInfo | |
| FPartyPrivacySettings | |
| FPartyRepData | Base struct used to replicate data about the state of the party to all members. |
| FSocialActionTimeTracker | |
| FSocialChatChannelConfig | |
| FSocialPlatformDescription | |
| FUserPlatform | Thin wrapper to infuse a raw platform string with some meaning |
Interfaces
| Name | Remarks |
|---|---|
| ISocialInteractionWrapper | Link between the class-polymorphism-based interaction handle and the static template-polymorphism-based interactions. |
| ISocialUserList |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnChatRoomCreatedOrJoined | TBaseDelegate_TwoParams< void, const FChatRoomId &, bool > | Delegate fired when chat room attempt has completed | Chatroom.h |
| FOnChatRoomLeft | TBaseDelegate_OneParam< void, const FChatRoomId & > | Delegate fired when chat room has been left | Chatroom.h |
| FOnCustomFilterUser | TBaseDelegate_OneParam< bool, const USocialUser & > | User/ISocialUserList.h | |
| FOnCustomIsInteractionAvailable | TBaseDelegate_OneParam< bool, const USocialUser & > | Interactions/SocialInteractionMacros.h | |
| FOnlinePartyDataConstPtr | TSharedPtr< const class FOnlinePartyData > | SocialDebugTools.h | |
| FOnlinePartyDataPtr | TSharedPtr< class FOnlinePartyData > | SocialDebugTools.h | |
| FOnNewSocialUserInitialized | TBaseDelegate_OneParam< void, USocialUser & > | User/SocialUser.h | |
| FOnQueryCompleted | TBaseDelegate_TwoParams< void, FName, const TSharedRef< class FSocialQueryBase > & > | SocialQuery.h | |
| FPartyDataReplicator | TPartyDataReplicator< FPartyRepData, USocialParty > | Party/SocialParty.h | |
| FPartyMemberDataReplicator | TPartyDataReplicator< FPartyMemberRepData, UPartyMember > | Party/PartyMember.h | |
| FSessionId | FString | Gives a smidge more meaning to the intended use for the string. These should just be UniqueId's (and are), but not reliably allocated as shared ptrs, so they cannot be replicated via FUniqueNetIdRepl. | Party/PartyTypes.h |
| FSocialChatMessagePtr | TSharedPtr< FSocialChatMessage > | SocialTypes.h | |
| FSocialChatMessagePtrConst | TSharedPtr< const FSocialChatMessage > | SocialTypes.h | |
| FSocialChatMessageRef | TSharedRef< FSocialChatMessage > | SocialTypes.h | |
| FSocialChatMessageRefConst | TSharedRef< const FSocialChatMessage > | SocialTypes.h | |
| FUniqueNetIdPtr | TSharedPtr< const FUniqueNetId > | SocialDebugTools.h | |
| FUserDependentAction | TBaseDelegate_OneParam< void, USocialUser & > | SocialToolkit.h | |
| IOnlinePartyJoinInfoConstPtr | TSharedPtr< const IOnlinePartyJoinInfo > | User/SocialUser.h | |
| IOnlinePartyJoinInfoConstPtr | TSharedPtr< const class IOnlinePartyJoinInfo > | SocialDebugTools.h | |
| IOnlinePartyJoinInfoConstRef | TSharedRef< const IOnlinePartyJoinInfo > | User/SocialUser.h | |
| ISocialUserListPtr | TSharedPtr< ISocialUserList > | SocialTypes.h | |
| ISocialUserListPtrConst | TSharedPtr< const ISocialUserList > | SocialTypes.h | |
| ISocialUserListRef | TSharedRef< ISocialUserList > | SocialTypes.h | |
| ISocialUserListRefConst | TSharedRef< const ISocialUserList > | SocialTypes.h |
Enums
Public
| Name | Remarks |
|---|---|
| EApprovalAction | |
| EChatSystemMessagePurpose | |
| ECrossplayPreference | |
| EPartyInviteRestriction | |
| EPartyJoinDenialReason | |
| EPartyType | |
| EPlatformIconDisplayRule | |
| ESocialChannelType | |
| ESocialPartyInviteFailureReason | |
| ESocialPartyInviteMethod | |
| ESocialRelationship | Per-OSS relationship types |
| ESocialSubsystem | All supported subsystems |
| ESocialUserStateFlags | OSS-agnostic user state filters (presence info generally required). |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AcceptFailReason_NotPendingInbound | const FString | SocialToolkit.h | ||
| CommandLineJoin | const FName | User has joined the party via command line. | Party/PartyTypes.h | |
| Creation | const FName | User has created the party. | Party/PartyTypes.h | |
| Invitation | const FName | User has joined the party via invitation. | Party/PartyTypes.h | |
| InviteFailReason_AddingBlockedFail | const FString | SocialToolkit.h | ||
| InviteFailReason_AddingSelfFail | const FString | SocialToolkit.h | ||
| InviteFailReason_AlreadyFriends | const FString | SocialToolkit.h | ||
| InviteFailReason_NotFound | const FString | SocialToolkit.h | ||
| PlatformSession | const FName | User has joined the party using a platform option. | Party/PartyTypes.h | |
| Presence | const FName | User has joined the party via presence. | Party/PartyTypes.h | |
| RequestToJoin | const FName | User has joined after requesting access | Party/PartyTypes.h | |
| STATCAT_Advanced | Logging related to parties Party module stats | PartyModule.h | ||
| Unspecified | const FName | User has joined via unknown/undocumented process. | Party/PartyTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TCHAR * LexToString
(
ESocialPartyInviteFailureReason Type |
Party/PartyTypes.h | ||
const TCHAR * LexToString
(
ESocialSubsystem InSubsystem |
SocialTypes.h | ||
const TCHAR * LexToString
(
ESocialRelationship Relationship |
SocialTypes.h | ||
const TCHAR * LexToString
(
ECrossplayPreference Preference |
SocialTypes.h | ||
bool operator!
(
ESocialUserStateFlags E |
User/ISocialUserList.h | ||
ESocialUserStateFlags operator&
(
ESocialUserStateFlags Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags & operator&=
(
ESocialUserStateFlags& Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags operator^
(
ESocialUserStateFlags Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags & operator^=
(
ESocialUserStateFlags& Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags operator|
(
ESocialUserStateFlags Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags & operator|=
(
ESocialUserStateFlags& Lhs, |
User/ISocialUserList.h | ||
ESocialUserStateFlags operator~
(
ESocialUserStateFlags E |
User/ISocialUserList.h | ||
bool OptedOutOfCrossplay
(
ECrossplayPreference InPreference |
SocialTypes.h | ||
const TCHAR * ToString
(
EPartyJoinDenialReason Type |
Party/PartyTypes.h | ||
const TCHAR * ToString
(
EPartyType Type |
Party/PartyTypes.h | ||
const TCHAR * ToString
(
EApprovalAction Type |
Party/PartyTypes.h | ||
const TCHAR * ToString
(
ESocialSubsystem SocialSubsystem |
SocialTypes.h |