FOnlineSearchSettingsAccelByte Class Reference

Inheritance diagram for FOnlineSearchSettingsAccelByte:

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

Static Public Member Functions
static void	Set (FOnlineSearchSettings &SearchSettings, FName Key, const TArray< FString > &Value, EOnlineComparisonOp::Type InType)
static void	Set (FOnlineSearchSettings &SearchSettings, FName Key, const TArray< double > &Value, EOnlineComparisonOp::Type InType)
static void	Set (FOnlineSearchSettings &SearchSettings, FName Key, const TArray< FString > &Value, EOnlineComparisonOp::Type InType, int32 ID)
static void	Set (FOnlineSearchSettings &SearchSettings, FName Key, const TArray< double > &Value, EOnlineComparisonOp::Type InType, int32 ID)
static bool	Get (const FOnlineSearchSettings &SearchSettings, FName Key, TArray< FString > &Value)
static bool	Get (const FOnlineSearchSettings &SearchSettings, FName Key, TArray< double > &Value)
static bool	Get (const FVariantData &Data, TArray< FString > &Value)
static bool	Get (const FVariantData &Data, TArray< double > &Value)
template<typename T>
static bool	GetInt (const FOnlineSearchSettings &SearchSettings, FName Key, T &OutValue)
static ESessionSettingsAccelByteArrayFieldType	GetArrayFieldType (const FOnlineSearchSettings &SearchSettings, FName Key)
static ESessionSettingsAccelByteArrayFieldType	GetArrayFieldType (const FVariantData &Data)

Member Function Documentation

Get() [1/6]

bool FOnlineSearchSettingsAccelByte::Get ( const FOnlineSearchSettings & SearchSettings, FName Key, TArray< double > & Value )

static

Gets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to fetch setting from
Key	key for the setting
Value	value of the setting

Returns

true if found, false otherwise

Get() [2/6]

bool FOnlineSearchSettingsAccelByte::Get ( const FOnlineSearchSettings & SearchSettings, FName Key, TArray< FString > & Value )

static

Gets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to fetch setting from
Key	key for the setting
Value	value of the setting

Returns

true if found, false otherwise

Get() [3/6]

bool FOnlineSearchSettingsAccelByte::Get ( const FVariantData & Data, TArray< double > & Value )

static

Gets an array-typed search setting value from variant data

Parameters

Data	variant data to get the value from
Value	value of the setting

Returns

a boolean indicating whether the value was retrieved

Get() [4/6]

bool FOnlineSearchSettingsAccelByte::Get ( const FVariantData & Data, TArray< FString > & Value )

static

Gets an array-typed search setting value from variant data

Parameters

Data	variant data to get the value from
Value	value of the setting

Returns

a boolean indicating whether the value was retrieved

Get() [5/6]

bool FOnlineSearchSettingsAccelByte::Get	(	FName	Key,
		TArray< double > &	Value ) const

Gets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting

Returns

true if found, false otherwise

Get() [6/6]

bool FOnlineSearchSettingsAccelByte::Get	(	FName	Key,
		TArray< FString > &	Value ) const

Gets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting

Returns

true if found, false otherwise

GetArrayFieldType() [1/2]

ESessionSettingsAccelByteArrayFieldType FOnlineSearchSettingsAccelByte::GetArrayFieldType ( const FOnlineSearchSettings & SearchSettings, FName Key )

static

Get the ESessionSettingsAccelByteArrayFieldType for a field

Parameters

SearchSettings	search settings to get the type from
Key	the key for the setting

Returns

an ESessionSettingsAccelByteArrayFieldType enum value

GetArrayFieldType() [2/2]

ESessionSettingsAccelByteArrayFieldType FOnlineSearchSettingsAccelByte::GetArrayFieldType ( const FVariantData & Data )

static

Get the ESessionSettingsAccelByteArrayFieldType for a VariantData field

Parameters

Data	variant data object to get the value from

Returns

an ESessionSettingsAccelByteArrayFieldType enum value

GetInt()

template<typename T>

template ONLINESUBSYSTEMACCELBYTE_API bool FOnlineSearchSettingsAccelByte::GetInt ( const FOnlineSearchSettings & SearchSettings, FName Key, T & OutValue )

static

Get a search setting double value as an integer. Search 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

SearchSettings	search 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/8]

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

Sets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting
InType	type of comparison

Set() [2/8]

void FOnlineSearchSettingsAccelByte::Set	(	FName	Key,
		const TArray< double > &	Value,
		EOnlineComparisonOp::Type	InType,
		int32	ID )

Sets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting
InType	type of comparison
ID	ID of comparison

Set() [3/8]

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

Sets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting
InType	type of comparison

Set() [4/8]

void FOnlineSearchSettingsAccelByte::Set	(	FName	Key,
		const TArray< FString > &	Value,
		EOnlineComparisonOp::Type	InType,
		int32	ID )

Sets a key value pair combination that defines a search parameter

Parameters

Key	key for the setting
Value	value of the setting
InType	type of comparison
ID	ID of comparison

Set() [5/8]

void FOnlineSearchSettingsAccelByte::Set ( FOnlineSearchSettings & SearchSettings, FName Key, const TArray< double > & Value, EOnlineComparisonOp::Type InType )

static

Sets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to apply to search parameter to
Key	key for the setting
Value	value of the setting
InType	type of comparison

Set() [6/8]

void FOnlineSearchSettingsAccelByte::Set ( FOnlineSearchSettings & SearchSettings, FName Key, const TArray< double > & Value, EOnlineComparisonOp::Type InType, int32 ID )

static

Sets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to apply to search parameter to
Key	key for the setting
Value	value of the setting
InType	type of comparison

Set() [7/8]

void FOnlineSearchSettingsAccelByte::Set ( FOnlineSearchSettings & SearchSettings, FName Key, const TArray< FString > & Value, EOnlineComparisonOp::Type InType )

static

Sets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to apply to search parameter to
Key	key for the setting
Value	value of the setting
InType	type of comparison

Set() [8/8]

void FOnlineSearchSettingsAccelByte::Set ( FOnlineSearchSettings & SearchSettings, FName Key, const TArray< FString > & Value, EOnlineComparisonOp::Type InType, int32 ID )

static

Sets a key value pair combination that defines a search parameter

Parameters

SearchSettings	search settings to apply to search parameter to
Key	key for the setting
Value	value of the setting
InType	type of comparison