Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

TOptional

When we have an optional value [IsSet()](API\Runtime\Core\Misc\TOptional\IsSet) returns true, and [GetValue()](API\Runtime\Core\Misc\TOptional\GetValue\2) is meaningful.

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/Optional.h
Include	#include "Misc/Optional.h"

Syntax

template<typename OptionalType>
struct TOptional

Remarks

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

Constructors

	Name	Description
	TOptional()	Construct an OptionalType with no value; i.e. unset
	TOptional ( const OptionalType& InValue )	Construct an OptionalType with a valid value.
	TOptional ( OptionalType&& InValue )
	TOptional ( FNullOpt )	Construct an OptionalType with an invalid value.
	TOptional ( const TOptional& InValue )	Copy/Move construction
	TOptional ( TOptional&& InValue )
	TOptional ( EInPlace, ArgTypes&&... Args )

Destructors

	Name	Description
	~TOptional()

Functions

		Name	Description
	OptionalType...	Emplace ( ArgsType&&... Args )
	const Option...	Get ( const OptionalType& DefaultValue )
	OptionalType...	GetPtrOrNull()
	const Option...	GetPtrOrNull()
	OptionalType...	GetValue()
	const Option...	GetValue()
	bool	IsSet()
	void	Reset()
	void	Serialize ( FArchive& Ar )

Operators

		Name	Description
		operator bool()
	const Option...	operator*()
	OptionalType...	operator*()
	TOptional &	operator= ( const TOptional& InValue )
	TOptional &	operator= ( TOptional&& InValue )
	TOptional &	operator= ( const OptionalType& InValue )
	TOptional &	operator= ( OptionalType&& InValue )
	const Option...	operator->()
	OptionalType...	operator->()

Typedefs

Name	Description
ElementType

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

Take our survey

Cancel