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

Light Theme

Dark Theme

FConstStructView

[FConstStructView](API\Plugins\StructUtils\FConstStructView) is "typed" struct pointer, it contains const pointer to struct plus [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) pointer.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FConstStructView

FStructView

References

Module	StructUtils
Header	/Engine/Plugins/Experimental/StructUtils/Source/StructUtils/Public/StructView.h
Include	#include "StructView.h"

Syntax

struct FConstStructView

Remarks

FConstStructView is "typed" struct pointer, it contains const pointer to struct plus UScriptStruct pointer. FConstStructView does not own the memory and will not free it when out of scope. It should be only used to pass struct pointer in a limited scope, or when the user controls the lifetime of the struct being stored. E.g. instead of passing ref or pointer to a FInstancedStruct, you should use FConstStructView or FStructView to pass around a view to the contents. FConstStructView is passed by value. FConstStructView is similar to FStructOnScope, but FConstStructView is a view only (FStructOnScope can either own the memory or be a view)

Variables

		Name	Description
	const UScriptSt...	ScriptStruct
	const uint8 ...	StructMemory

Constructors

	Name	Description
	FConstStructView()
	FConstStructView ( const FInstancedStruct& InstancedS... )
	FConstStructView ( const FConstSharedStruct& SharedSt... )
	FConstStructView ( const FConstStructView& Other )	Copy constructors
	FConstStructView ( FConstStructView&& Other )
	FConstStructView ( const UScriptStruct* InScriptS..., const uint8* InStructMemory )

Functions

	Name	Description
const T &	Get()	Returns const reference to the struct, this getter assumes that all data is valid.
const uint8 ...	GetMemory()	Returns const pointer to struct memory.
const T *...	GetPtr()	Returns const pointer to the struct, or nullptr if cast is not valid.
const UScrip...	GetScriptStruct()	Returns struct type.
bool	IsValid()	Returns True if the struct is valid.
FConstStruct...	Make ( const T& Struct )	Creates a new FStructView from the templated struct
void	Reset()	Reset to empty.
void	ResetStructData()
void	SetStructData ( const UScriptStruct* InScriptS..., const uint8* InStructMemory )

Operators

	Name	Description
bool	operator!= ( const OtherType& Other )
FConstStruct...	operator= ( FConstStructView&& Other )
FConstStruct...	operator= ( const FConstStructView& Other )	Assignment operators
bool	operator== ( const OtherType& Other )	Comparison operators. it does not compare the internal structure itself