FVariant

Implements an extensible union of multiple types.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Variant.h

Include

#include "Misc/Variant.h"

Syntax

class FVariant

Remarks

Implements an extensible union of multiple types.

Variant types can be used to store a range of different built-in types, as well as user defined types. The values are internally serialized into a byte array, which means that only FArchive serializable types are supported at this time.

Constructors

Name Description

Public function

FVariant()

Default constructor.

Public function

FVariant

(
    const FVariant&
)

Public function

FVariant

(
    FVariant&& Other
)

Public function

FVariant

(
    T InValue
)

Creates and initializes a new instance with the specified value.

Public function

FVariant

(
    TArray< uint8 >&& InArray
)

Creates and initializes a new instance from a byte array.

Public function

FVariant

(
    const TArray< uint8 >& InArray
)

Public function

FVariant

(
    const TCHAR* InString
)

Creates and initializes a new instance from a TCHAR string.

Destructors

Name Description

Public function

~FVariant()

Functions

Name Description

Public function

void

 

Empty()

Empties the value.

Public function Const

const TArray...

 

GetBytes()

Gets the stored value as a byte array.

Public function Const

int32

 

GetSize()

Gets the stored value's size (in bytes).

Public function Const

EVariantType...

 

GetType()

Gets the stored value's type.

Public function Const

T

 

GetValue()

Gets the stored value.

Public function Const

TArray< uint...

 

GetValue()

Gets the stored value for byte arrays.

Public function Const

bool

 

IsEmpty()

Checks whether the value is empty.

Operators

Name Description

Public function Const

 

operator T()

Implicit conversion operator.

Public function Const

bool

 

operator!=

(
    const FVariant& Other
)

Comparison operator for inequality.

Public function

FVariant &

 

operator=

(
    const TArray< uint8 >& InArray
)

Public function

FVariant &

 

operator=

(
    const FVariant&
)

Public function

FVariant &

 

operator=

(
    FVariant&& Other
)

Public function

FVariant &

 

operator=

(
    T InValue
)

Assignment operator.

Public function

FVariant &

 

operator=

(
    TArray< uint8 >&& InArray
)

Assignment operator for byte arrays.

Public function

FVariant &

 

operator=

(
    const TCHAR* InString
)

Assignment operator for TCHAR strings.

Public function Const

bool

 

operator==

(
    const FVariant& Other
)

Comparison operator for equality.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss