Inheritance diagram for FOnlineSessionSettingsAccelByte:

Public Member Functions
void	Set (FName Key, const TArray< FString > &Value, EOnlineDataAdvertisementType::Type InType, int32 InID)
void	Set (FName Key, const TArray< double > &Value, EOnlineDataAdvertisementType::Type InType, int32 InID)
void	Set (FName Key, const TArray< FString > &Value, EOnlineDataAdvertisementType::Type InType)
void	Set (FName Key, const TArray< double > &Value, EOnlineDataAdvertisementType::Type InType)
void	Set (FName Key, const TArray< FString > &Value)
void	Set (FName Key, const TArray< double > &Value)
bool	Get (FName Key, TArray< FString > &OutValue) const
bool	Get (FName Key, TArray< double > &OutValue) const

Static Public Member Functions
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< FString > &Value, EOnlineDataAdvertisementType::Type InType, int32 InID)
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< double > &Value, EOnlineDataAdvertisementType::Type InType, int32 InID)
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< FString > &Value, EOnlineDataAdvertisementType::Type InType)
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< double > &Value, EOnlineDataAdvertisementType::Type InType)
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< FString > &Value)
static void	Set (FOnlineSessionSettings &SessionSettings, FName Key, const TArray< double > &Value)
static void	Set (FSessionSettings &SessionSettings, FName Key, const TArray< FString > &Value)
static void	Set (FSessionSettings &SessionSettings, FName Key, const TArray< double > &Value)
static bool	Get (const FOnlineSessionSettings &SessionSettings, FName Key, TArray< FString > &OutValue)
static bool	Get (const FOnlineSessionSettings &SessionSettings, FName Key, TArray< double > &OutValue)
template<typename T>
static bool	GetInt (const FOnlineSessionSettings &SessionSettings, FName Key, T &OutValue)
static ESessionSettingsAccelByteArrayFieldType	GetArrayFieldType (const FOnlineSessionSettings &SessionSettings, FName Key)

Member Function Documentation

◆ Get() [1/4]

bool FOnlineSessionSettingsAccelByte::Get	(	const FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		TArray< double > &	OutValue )

static

Gets a setting value by its name

Parameters

SessionSettings	settings object to get the value from
Key	key for the setting
OutValue	setting value

Returns: an boolean indicating whether the value was retrieved

◆ Get() [2/4]

bool FOnlineSessionSettingsAccelByte::Get	(	const FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		TArray< FString > &	OutValue )

static

Gets a setting value by its name

Parameters

SessionSettings	settings object to get the value from
Key	key for the setting
OutValue	setting value

Returns: an boolean indicating whether the value was retrieved

◆ Get() [3/4]

bool FOnlineSessionSettingsAccelByte::Get	(	FName	Key,
		TArray< double > &	OutValue ) const

Gets a setting value by its name

Parameters

Key	key for the setting
OutValue	setting value

Returns: an boolean indicating whether the value was retrieved

◆ Get() [4/4]

bool FOnlineSessionSettingsAccelByte::Get	(	FName	Key,
		TArray< FString > &	OutValue ) const

Gets a setting value by its name

Parameters

Key	key for the setting
OutValue	setting value

Returns: an boolean indicating whether the value was retrieved

◆ GetArrayFieldType()

ESessionSettingsAccelByteArrayFieldType FOnlineSessionSettingsAccelByte::GetArrayFieldType	(	const FOnlineSessionSettings &	SessionSettings,
		FName	Key )

static

Get the ESessionSettingsAccelByteArrayFieldType for a field

Parameters

SessionSettings	settings to get the type from
Key	the key for the setting

Returns: an ESessionSettingsAccelByteArrayFieldType enum value

◆ GetInt()

template<typename T>

template ONLINESUBSYSTEMACCELBYTE_API bool FOnlineSessionSettingsAccelByte::GetInt	(	const FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		T &	OutValue )

static

Get a session setting double value as an integer. Session settings across the OSS are stored as a double. However, due to limitations with FVariantData, integers cannot be retrieved from these double values, even if they are within range.

Parameters

SessionSettings	session settings object to fetch the setting from
Key	setting key that we want to read
Value	output value that will be returned to the caller

Returns: boolean that is true if an integer could be grabbed, or false otherwise.

◆ Set() [1/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< double > &	Value )

Sets a key value pair combination that defines a session setting

Parameters

Key	key for the setting
Value	setting value

◆ Set() [2/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< double > &	Value,
		EOnlineDataAdvertisementType::Type	InType )

Sets a key value pair combination that defines a session setting

Parameters

Key	key for the setting
Value	value of the setting
InType	type of online advertisement

◆ Set() [3/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< double > &	Value,
		EOnlineDataAdvertisementType::Type	InType,
		int32	InID )

Sets a key value pair combination that defines a session setting with an ID

Parameters

Key	key for the setting
Value	value of the setting
InType	type of online advertisement
InID	ID for this session setting

◆ Set() [4/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< FString > &	Value )

Sets a key value pair combination that defines a session setting

Parameters

Key	key for the setting
Value	setting value

◆ Set() [5/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< FString > &	Value,
		EOnlineDataAdvertisementType::Type	InType )

Sets a key value pair combination that defines a session setting

Parameters

Key	key for the setting
Value	value of the setting
InType	type of online advertisement

◆ Set() [6/14]

void FOnlineSessionSettingsAccelByte::Set	(	FName	Key,
		const TArray< FString > &	Value,
		EOnlineDataAdvertisementType::Type	InType,
		int32	InID )

Sets a key value pair combination that defines a session setting with an ID

Parameters

Key	key for the setting
Value	value of the setting
InType	type of online advertisement
InID	ID for this session setting

◆ Set() [7/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< double > &	Value )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	setting value

◆ Set() [8/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< double > &	Value,
		EOnlineDataAdvertisementType::Type	InType )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	value of the setting
InType	type of online advertisement

◆ Set() [9/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< double > &	Value,
		EOnlineDataAdvertisementType::Type	InType,
		int32	InID )

static

Sets a key value pair combination that defines a session setting with an ID

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	value of the setting
InType	type of online advertisement
InID	ID for this session setting

◆ Set() [10/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< FString > &	Value )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	setting value

◆ Set() [11/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< FString > &	Value,
		EOnlineDataAdvertisementType::Type	InType )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	value of the setting
InType	type of online advertisement

◆ Set() [12/14]

void FOnlineSessionSettingsAccelByte::Set	(	FOnlineSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< FString > &	Value,
		EOnlineDataAdvertisementType::Type	InType,
		int32	InID )

static

Sets a key value pair combination that defines a session setting with an ID

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	value of the setting
InType	type of online advertisement
InID	ID for this session setting

◆ Set() [13/14]

void FOnlineSessionSettingsAccelByte::Set	(	FSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< double > &	Value )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	setting value

◆ Set() [14/14]

void FOnlineSessionSettingsAccelByte::Set	(	FSessionSettings &	SessionSettings,
		FName	Key,
		const TArray< FString > &	Value )

static

Sets a key value pair combination that defines a session setting

Parameters

SessionSettings	settings object to set the value in
Key	key for the setting
Value	setting value

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ Get() [1/4]

◆ Get() [2/4]

◆ Get() [3/4]

◆ Get() [4/4]

◆ GetArrayFieldType()

◆ GetInt()

◆ Set() [1/14]

◆ Set() [2/14]

◆ Set() [3/14]

◆ Set() [4/14]

◆ Set() [5/14]

◆ Set() [6/14]

◆ Set() [7/14]

◆ Set() [8/14]

◆ Set() [9/14]

◆ Set() [10/14]

◆ Set() [11/14]

◆ Set() [12/14]

◆ Set() [13/14]

◆ Set() [14/14]