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

#include <StructView.h>

+ Inheritance diagram for TConstStructView< BaseStructT >:

Public Member Functions

 TConstStructView ()=default
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const T &InStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const uint8 *InStructMemory=nullptr)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const TInstancedStruct< T > &InstancedStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const TSharedStruct< T > &SharedStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const TConstSharedStruct< T > &SharedStruct)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
 TConstStructView (const TStructView< T > StructView)
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
constexpr const T & Get () const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
constexpr const T * GetPtr () const
 
BaseStructT * operator-> () const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool operator== (const TConstStructView< T > &Other) const
 
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
bool operator!= (const TConstStructView< T > &Other) const
 
- Public Member Functions inherited from FConstStructView
 FConstStructView ()=default
 
 FConstStructView (const UScriptStruct *InScriptStruct, const uint8 *InStructMemory=nullptr)
 
 FConstStructView (const FInstancedStruct &InstancedStruct)
 
 FConstStructView (const FSharedStruct &SharedStruct)
 
 FConstStructView (const FConstSharedStruct &SharedStruct)
 
 FConstStructView (const FStructView StructView)
 
template<typename T >
requires (std::is_const_v<T>)
constexpr T & Get () const
 
template<typename T >
requires (std::is_const_v<T>)
constexpr T * GetPtr () const
 
const UScriptStruct * GetScriptStruct () const
 
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
 
void SetStructData (const UScriptStruct *InScriptStruct, const uint8 *InStructMemory)
 

Additional Inherited Members

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

Detailed Description

template<typename BaseStructT>
struct TConstStructView< BaseStructT >

TConstStructView is a type-safe FConstStructView wrapper against the given BaseStruct type.

Example:

TConstStructView<FTestStructBase> Test;

TArray<TConstStructView<FTestStructBase>> TestArray;

Constructor & Destructor Documentation

◆ TConstStructView() [1/7]

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

◆ TConstStructView() [2/7]

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

◆ TConstStructView() [3/7]

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

◆ TConstStructView() [4/7]

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

◆ TConstStructView() [5/7]

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

◆ TConstStructView() [6/7]

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

◆ TConstStructView() [7/7]

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

Member Function Documentation

◆ Get()

template<typename BaseStructT >
template<typename T = BaseStructT>
requires (std::is_base_of_v<BaseStructT, std::decay_t<T>>)
constexpr const T & TConstStructView< BaseStructT >::Get ( ) const
inlineconstexpr

Returns const 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>>)
constexpr const T * TConstStructView< BaseStructT >::GetPtr ( ) const
inlineconstexpr

Returns const 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 TConstStructView< BaseStructT >::operator!= ( const TConstStructView< T > &  Other) const
inline

◆ operator->()

template<typename BaseStructT >
BaseStructT * TConstStructView< 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 TConstStructView< BaseStructT >::operator== ( const TConstStructView< 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: