TOptional | Unreal Engine 5.7 Documentation

When we have an optional value IsSet() returns true, and GetValue() is meaningful. Otherwise GetValue() is not meaningful.


Name	TOptional
Type	struct
Header File	/Engine/Source/Runtime/Core/Public/Misc/Optional.h
Include Path	#include "Misc/Optional.h"

Syntax

template<typename OptionalType>  
struct TOptional : private UE::Core::Private::TOptionalBase< OptionalType >

Name	Remarks	Include Path
TOptional ( TOptional&& Other )		Misc/Optional.h
constexpr TOptional ()	Construct an OptionalType intrusively with no value; i.e. unset	Misc/Optional.h
constexpr TOptional ()	Construct an OptionalType with no value; i.e. unset	Misc/Optional.h
constexpr TOptional ( const OptionalType& InValue )	Construct an OptionalType with a valid value.	Misc/Optional.h
constexpr TOptional ( OptionalType&& InValue )		Misc/Optional.h
constexpr TOptional ( FNullOpt )	Construct an OptionalType with an invalid value.	Misc/Optional.h
TOptional ( const TOptional& Other )	Copy/Move construction	Misc/Optional.h
constexpr TOptional ( EInPlace, ArgTypes&&... Args )		Misc/Optional.h

Name	Remarks	Include Path	Unreal Specifiers
constexpr ~TOptional()		Misc/Optional.h

Name	Type	Include Path
ElementType	OptionalType	Misc/Optional.h
FOptional	UE::Core::Private::FOptional	Misc/Optional.h
Super	UE::Core::Private::TOptionalBase< OptionalType >	Misc/Optional.h

Name	Type	Remarks	Include Path
bUsingIntrusiveUnsetState	bool		Misc/Optional.h

Name	Type	Remarks	Include Path	Unreal Specifiers
FOptional	friend		Misc/Optional.h

Name	Remarks	Include Path	Unreal Specifiers
OptionalType & Emplace ( ArgsType&&... Args )		Misc/Optional.h
const OptionalType & Get ( const OptionalType& DefaultValue ) const		Misc/Optional.h
OptionalType * GetPtrOrNull ()		Misc/Optional.h
const OptionalType * GetPtrOrNull ()		Misc/Optional.h
const OptionalType & GetValue ()		Misc/Optional.h
OptionalType & GetValue ()		Misc/Optional.h
bool IsSet()		Misc/Optional.h
void Reset()		Misc/Optional.h
void Serialize ( FArchive& Ar )		Misc/Optional.h

Name	Remarks	Include Path	Unreal Specifiers
constexpr operator bool()		Misc/Optional.h
OptionalType & operator* ()		Misc/Optional.h
const OptionalType & operator* ()		Misc/Optional.h
TOptional & operator= ( const TOptional& Other )		Misc/Optional.h
TOptional & operator= ( TOptional&& Other )		Misc/Optional.h
TOptional & operator= ( const OptionalType& InValue )		Misc/Optional.h
TOptional & operator= ( OptionalType&& InValue )		Misc/Optional.h
OptionalType * operator-> ()		Misc/Optional.h
const OptionalType * operator-> ()		Misc/Optional.h