Navigation
API > API/Plugins > API/Plugins/Party
Config-driven settings object for the social framework. Only the CDO is ever expected to be used, no instance is ever expected to be created.
| Name | USocialSettings |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/SocialSettings.h |
| Include Path | #include "SocialSettings.h" |
Syntax
UCLASS (MinimalAPI, Config=Game)
class USocialSettings : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USocialSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USocialSettings() |
SocialSettings.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bLeavePartyOnDisconnect | bool | Should we leave a party when it enters the disconnected state? | SocialSettings.h |
|
| bMustSendPrimaryInvites | bool | If true, always send invites using the publisher's system even if already sent via a platform system | SocialSettings.h |
|
| bPreferPlatformInvites | bool | If true, prioritize the platform's social system over the publisher's | SocialSettings.h |
|
| bSetDesiredPrivacyOnLocalPlayerBecomesLeader | bool | How often the user list will update in seconds | SocialSettings.h |
|
| DefaultMaxPartySize | int32 | How many players are in a party by default | SocialSettings.h |
|
| MaxNicknameLength | int32 | Longest possible player nickname | SocialSettings.h |
|
| MinNicknameLength | int32 | Shortest possible player nickname | SocialSettings.h |
|
| OssNamesWithEnvironmentIdPrefix | TArray< FName > | The specific OSS' that have their IDs stored with an additional prefix for the environment to which they pertain. | SocialSettings.h |
|
| SocialPlatformDescriptions | TArray< FSocialPlatformDescription > | SocialSettings.h |
|
|
| SonyOSSNames | TArray< FName > | SocialSettings.h |
|
|
| UserListAutoUpdateRate | float | SocialSettings.h |
|
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 GetDefaultMaxPartySize() |
SocialSettings.h | ||
static int32 GetMaxNicknameLength() |
SocialSettings.h | ||
static int32 GetMinNicknameLength() |
SocialSettings.h | ||
static const FSocialPlatformDescription * GetSocialPlatformDescriptionForOnlineSubsystem
(
const FName& OnlineSubsystemName |
Get a platform description (from GetSocialPlatformDescriptions) for a specific OnlineSubsystem. | SocialSettings.h | |
static const TArray< FSocialPlatformDescription > & GetSocialPlatformDescriptions() |
SocialSettings.h | ||
static FString GetUniqueIdEnvironmentPrefix
(
ESocialSubsystem SubsystemType |
SocialSettings.h | ||
static float GetUserListAutoUpdateRate() |
SocialSettings.h | ||
static bool IsSonyOSS
(
const FName& OSSName |
Checks if current OnlineSubsystem name is Sony specific | SocialSettings.h | |
static bool MustSendPrimaryInvites() |
SocialSettings.h | ||
static bool ShouldLeavePartyOnDisconnect() |
SocialSettings.h | ||
static bool ShouldPreferPlatformInvites() |
SocialSettings.h | ||
static bool ShouldSetDesiredPrivacyOnLocalPlayerBecomesLeader() |
SocialSettings.h |