1. Epic GamesDeveloper
  3. FVariantData

FVariantData

Container for storing data of variable type

API > API/Plugins > API/Plugins/OnlineSubsystem

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineKeyValuePair.h
Include #include "OnlineKeyValuePair.h"

Syntax

class FVariantData

Remarks

Container for storing data of variable type

Constructors

  Type Name Description
Public function   Constructor
Public function  

FVariantData ( const ValueType& InData
)

 Constructor starting with an initialized value/type
Public function  

FVariantData ( const FVariantData& Other
)

 Copy constructor. Copies the other into this object
Public function   Move constructor. Moves the other into this object

Destructors

  Type Name Description
Public function   Cleans up the data to prevent leaks

Functions

  Type Name Description
Public function Const void

AddToJsonObject ( const TSharedRef< FJsonObject >& JsonObject,
const FString& Name,
const bool bWithTypeSuffix
)

 Insert variant data into json object
Public function void

Decrement ( TYPE DecBy
)

 Decrements the value by the specified amount
Public function void Decrements the numeric value by 1
Public function void

Empty ()

 Cleans up the existing data and sets the type to ODT_Empty
Public function bool

FromJson ( const TSharedRef< class FJsonObject >& JsonObject
)

 Convert json object to variant data from "type,value" fields
Public function bool

FromJsonValue ( const FString& Name,
const TSharedRef< class FJsonValue >& JsonValue,
FString& OutName
)

 Convert json object to variant data from Name_
Public function bool

FromString ( const FString& NewValue
)

 Converts the string to the specified type of data for this setting
Public function Const int Returns the estimated maximum size of the value when encoded as an escaped string.
Public function Const const EOnlineKeyValuePairDataType::Type

GetType ()

 Get the key for this key value pair
Public function Const const TCHAR *  
Public function Const FString Combine the type suffix given this variant's type
Public function Const void

GetValue ( uint64& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( TSharedPtr< class FJsonObject >& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( TArray< uint8 >& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( double& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( int64& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( TArray< TSharedPtr< class FJsonValue >>& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( uint32& OutSize,
uint8** OutData
)

 Copies the data after verifying the type.
Public function Const void

GetValue ( float& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( bool& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( uint32& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( int32& OutData
)

 Copies the data after verifying the type
Public function Const void

GetValue ( FString& OutData
)

 Copies the data after verifying the type
Public function void

Increment ( TYPE IncBy
)

 Increments the value by the specified amount
Public function void Increments the numeric value by 1
Public function Const bool Returns true if Type is numeric
Public function void

SetJsonValueFromString ( const FString& InData
)

 Copies the data and sets the type
Public function void

SetValue ( const TSharedRef< class FJsonObject >& InData
)

 Copies the data and sets the type
Public function void

SetValue ( const FString& InData
)

 Copies the data and sets the type
Public function void

SetValue ( const TCHAR* InData
)

 Copies the data and sets the type
Public function void

SetValue ( int32 InData
)

 Copies the data and sets the type
Public function void

SetValue ( uint32 InData
)

 Copies the data and sets the type
Public function void

SetValue ( bool InData
)

 Copies the data and sets the type
Public function void

SetValue ( double InData
)

 Copies the data and sets the type
Public function void

SetValue ( float InData
)

 Copies the data and sets the type
Public function void

SetValue ( const TArray< uint8 >& InData
)

 Copies the data and sets the type
Public function void

SetValue ( int64 InData
)

 Copies the data and sets the type
Public function void

SetValue ( uint64 InData
)

 Copies the data and sets the type
Public function void

SetValue ( uint32 Size,
const uint8* InData
)

 Copies the data and sets the type
Public function Const TSharedRef< class FJsonObject >

ToJson ()

 Convert variant data to json object with "type,value" fields
Public function Const FString Converts the data into a string representation

Operators

  Type Name Description
Public function Const bool

operator!= ( const FVariantData& Other
)

  
Public function FVariantData &

operator= ( const FVariantData& Other
)

 Assignment operator. Copies the other into this object
Public function FVariantData &

operator= ( FVariantData&& Other
)

 Move Assignment operator. Moves the other into this object
Public function Const bool

operator== ( const FVariantData& Other
)

 Comparison of two settings data classes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page