Navigation
API > API/Plugins > API/Plugins/Party
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USocialToolkit
References
| Module | Party |
| Header | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/SocialToolkit.h |
| Include | #include "SocialToolkit.h" |
Syntax
UCLASS&40;Within&61;SocialManager, Config&61;Game&41;
class USocialToolkit :
public UObject,
public FExec
Remarks
Represents the full suite of social functionality available to a given LocalPlayer
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bQueryBlockedPlayersOnStartup | ||
| bool | bQueryFriendsOnStartup | Something nicer is definitely possible and worth revisiting. | |
| bool | bQueryRecentPlayersOnStartup | ||
| TSubclassOf< USocialChatManager > | ChatManagerClass | Class to use when creating the ChatManager | |
| FString | FriendListToQuery | The name of the friends list to query | |
| FString | RecentPlayerNamespaceToQuery | The name of the recent player namespace to query | |
| TSubclassOf< USocialUser > | SocialUserClass | The type of SocialUser to create to represent known users |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | AcceptFriendInvite
(
const USocialUser& SocialUser, |
||
| bool | AcceptFriendInviteInternal
(
const USocialUser& SocialUser, |
Only handles accepting a friend request via the friends interface, assumes all checks are handled previously | |
| void | AddLocalUserOnlineProperties
(
FPresenceProperties OnlineProperties |
||
| bool | Can we automatically re-create a persistent party, for example on party join failure or on party kick? Typically you will want to, so the user always has a party, but there may be scenarios where you want to delay creating a new party until the client is in a better state. | ||
| TSharedRef< ISocialUserList > | CreateUserList
(
const FSocialUserListConfig& ListConfig |
||
| bool | |||
| USocialUser * | FindUser
(
const FUniqueNetIdRepl& UserId |
Finds a SocialUser given a unique net ID from any OSS | |
| const TArray< USocialUser * > & | GetAllUsers () |
||
| bool | GetAuthAttribute
(
ESocialSubsystem SubsystemType, |
||
| USocialChatManager & | |||
| TSubclassOf< USocialChatManager > | |||
| USocialUser & | GetLocalUser () |
||
| FUniqueNetIdRepl | GetLocalUserNetId
(
ESocialSubsystem SubsystemType |
||
| int32 | |||
| ULocalPlayer & | |||
| const FOnlineUserPresence * | GetPresenceInfo
(
ESocialSubsystem SubsystemType |
||
| const FString & | |||
| USocialManager & | |||
| IOnlineSubsystem * | GetSocialOss
(
ESocialSubsystem SubsystemType |
||
| ToolkitT * | GetToolkitForPlayer
(
const ULocalPlayer* LocalPlayer |
||
| void | HandleAcceptFriendInviteComplete
(
int32 LocalUserNum, |
Handle result of AcceptFriendInvite | |
| void | HandleSendFriendInviteComplete
(
int32 LocalUserNum, |
Handle result of TrySendFriendInviteInternal | |
| void | HandleUserInvalidated
(
USocialUser& InvalidUser |
||
| void | InitializeToolkit
(
ULocalPlayer& InOwningLocalPlayer |
||
| bool | IsFriendshipRestricted
(
const USocialUser& SocialUser, |
||
| const bool | IsInviteAllowedFromUser
(
const USocialUser& User, |
Whether we allow other users to send us invites | |
| bool | |||
| void | NotifyPartyInviteReceived
(
USocialUser& SocialUser, |
||
| void | NotifyPartyInviteRemoved
(
USocialUser& SocialUser, |
||
| void | NotifySubsystemIdEstablished
(
USocialUser& SocialUser, |
||
| void | OnAcceptFriendInviteComplete
(
const FUniqueNetId& InviterUserId, |
||
| void | OnBlockPlayerComplete
(
int32 LocalUserNum, |
||
| void | OnDeleteFriendComplete
(
int32 LocalPlayer, |
||
| FFriendInviteEvent & | |||
| FFriendInviteEvent & | |||
| void | OnFriendPresenceDidChange
(
const USocialUser& FriendSocialUser, |
Called when a Friend's presence did change | |
| FOnRelationshipEstablished & | |||
| FOnKnownUserInitialized & | |||
| void | |||
| void | |||
| FPartyInviteEvent & | |||
| FPartyInviteEvent & | |||
| FOnPartyRequestToJoinReceivedEvent & | |||
| FOnPartyRequestToJoinRemovedEvent & | |||
| FOnPartyRequestToJoinSentEvent & | |||
| void | OnQueryBlockedPlayersComplete
(
const FUniqueNetId& UserId, |
||
| void | OnQueryBlockedPlayersSuccess
(
ESocialSubsystem SubsystemType, |
||
| void | OnQueryFriendsListSuccess
(
ESocialSubsystem SubsystemType, |
||
| void | OnQueryRecentPlayersComplete
(
const FUniqueNetId& UserId, |
||
| void | OnQueryRecentPlayersSuccess
(
ESocialSubsystem SubsystemType, |
||
| void | OnReadFriendsListComplete
(
int32 LocalUserNum, |
||
| FOnRelationshipEstablished & | |||
| void | OnSendFriendInviteComplete
(
const FUniqueNetId& InvitedUserId, |
||
| FOnSocialUserInvalidated & | |||
| FBasicToolkitEvent & | |||
| void | OnUnblockPlayerComplete
(
int32 LocalUserNum, |
||
| FOnRelationshipEstablished & | |||
| void | |||
| void | |||
| void | |||
| void | QueueUserDependentAction
(
const FUniqueNetIdRepl& SubsystemId, |
Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established. | |
| void | QueueUserDependentAction
(
const FUniqueNetIdRepl& UserId, |
Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established. | |
| bool | SendFriendInviteInternal
(
USocialUser& SocialUser, |
Only handles sending a friend request via the friends interface, assumes all checks are handled previously | |
| void | SetLocalUserOnlineState
(
EOnlinePresenceState::Type OnlineState |
||
| void | TrySendFriendInvite
(
const FString& DisplayNameOrEmail |
Attempts to send a friend invite to another user based on display name or email. | |
| bool | TrySendFriendInvite
(
USocialUser& SocialUser, |
Classes
Constants
| Name | Description |
|---|---|
| AllToolkitsByOwningPlayer |