UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
TStructView< BaseStructT > Struct Template Reference

#include <StructView.h>

+ Inheritance diagram for TStructView< BaseStructT >:

Public Member Functions

 TStructView ()=default
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TStructView (T &InStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TStructView (uint8 *InStructMemory=nullptr)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TStructView (const UScriptStruct *InScriptStruct, uint8 *InStructMemory=nullptr)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TStructView (TInstancedStruct< T > &InstancedStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TStructView (const TSharedStruct< T > &SharedStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
T & Get () const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
T * GetPtr () const
 
BaseStructT * operator-> () const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool operator== (const TStructView< T > &Other) const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool operator!= (const TStructView< T > &Other) const
 
- Public Member Functions inherited from FStructView
 FStructView ()=default
 
 FStructView (const UScriptStruct *InScriptStruct, uint8 *InStructMemory=nullptr)
 
 FStructView (FInstancedStruct &InstancedStruct)
 
 FStructView (const FSharedStruct &SharedStruct)
 
template<typename T >
T & Get () const
 
template<typename T >
T * GetPtr () const
 
const UScriptStruct * GetScriptStruct () const
 
uint8 * GetMemory () const
 
void Reset ()
 
bool IsValid () const
 
template<typename OtherType >
bool operator== (const OtherType &Other) const
 
template<typename OtherType >
bool operator!= (const OtherType &Other) const
 

Additional Inherited Members

- Static Public Member Functions inherited from FStructView
template<typename T >
static FStructView Make (T &InStruct)
 
- Protected Attributes inherited from FStructView
const UScriptStruct * ScriptStruct = nullptr
 
uint8 * StructMemory = nullptr
 

Detailed Description

template<typename BaseStructT>
struct TStructView< BaseStructT >

TStructView is a type-safe FStructView wrapper against the given BaseStruct type.

Example:

TStructView<FTestStructBase> Test;

TArray<TStructView<FTestStructBase>> TestArray;

Constructor & Destructor Documentation

◆ TStructView() [1/6]

template<typename BaseStructT >
TStructView< BaseStructT >::TStructView ( )
explicitdefault

◆ TStructView() [2/6]

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
TStructView< BaseStructT >::TStructView ( T &  InStruct)
inline

◆ TStructView() [3/6]

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
TStructView< BaseStructT >::TStructView ( uint8 *  InStructMemory = nullptr)
inlineexplicit

◆ TStructView() [4/6]

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
TStructView< BaseStructT >::TStructView ( const UScriptStruct *  InScriptStruct,
uint8 *  InStructMemory = nullptr 
)
inlineexplicit

◆ TStructView() [5/6]

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
TStructView< BaseStructT >::TStructView ( TInstancedStruct< T > &  InstancedStruct)
inline

◆ TStructView() [6/6]

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
TStructView< BaseStructT >::TStructView ( const TSharedStruct< T > &  SharedStruct)
inline

Member Function Documentation

◆ Get()

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
T & TStructView< BaseStructT >::Get ( ) const
inline

Returns mutable reference to the struct, this getter assumes that all data is valid.

◆ GetPtr()

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
T * TStructView< BaseStructT >::GetPtr ( ) const
inline

Returns mutable pointer to the struct, or nullptr if cast is not valid.

◆ operator!=()

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool TStructView< BaseStructT >::operator!= ( const TStructView< T > &  Other) const
inline

◆ operator->()

template<typename BaseStructT >
BaseStructT * TStructView< BaseStructT >::operator-> ( ) const
inline

Simplified accessor for members of the guaranteed minimum structure type

◆ operator==()

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool TStructView< BaseStructT >::operator== ( const TStructView< T > &  Other) const
inline

Comparison operators. Note: it does not compare the internal structure itself

The documentation for this struct was generated from the following files: