Navigation
Unreal Engine C++ API Reference > Runtime > CoreUObject > StructUtils
References
Module | CoreUObject |
Header | /Engine/Source/Runtime/CoreUObject/Public/StructUtils/SharedStruct.h |
Include | #include "StructUtils/SharedStruct.h" |
Syntax
USTRUCT ()
struct FConstSharedStruct
Remarks
FConstSharedStruct is the same as the FSharedStruct but restricts the API to return const struct type.
A 'const FConstSharedStruct' can not be made to point at another instance of a struct, whilst a vanila FConstSharedStruct can. In either case the struct data is immutable.
See FSharedStruct for more information.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
TSharedPtr< const FStructSharedMemory > | StructMemoryPtr |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
|||
![]() |
FConstSharedStruct
(
const FConstSharedStruct& Other |
||
![]() |
FConstSharedStruct
(
const FSharedStruct& SharedStruct |
||
![]() |
FConstSharedStruct
(
FConstSharedStruct&& Other |
||
![]() |
FConstSharedStruct
(
FSharedStruct&& SharedStruct |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddStructReferencedObjects
(
FReferenceCollector& Collector |
|
![]() ![]() |
bool | CompareStructValues
(
const OtherType& Other, |
Determines whether Other contains same values as `this_ |
![]() ![]() |
TEnableIfTIsConst< T >::Value, constT & >::Type | Get () |
Returns const reference to the struct, this getter assumes that all data is valid. |
![]() ![]() |
TEnableIf< TIsConst< T >::Value, T & >::Type | Get () |
Returns const reference to the struct, this getter assumes that all data is valid. |
![]() ![]() |
const uint8 * | GetMemory () |
Returns const pointer to struct memory. |
![]() ![]() |
TEnableIfTIsConst< T >::Value, constT * >::Type | GetPtr () |
Returns const pointer to the struct, or nullptr if cast is not valid. |
![]() ![]() |
TEnableIf< TIsConst< T >::Value, T * >::Type | GetPtr () |
Returns const pointer to the struct, or nullptr if cast is not valid. |
![]() ![]() |
const UScriptStruct * | Returns struct type. | |
![]() |
TObjectPtr< const UScriptStruct > * | ||
![]() ![]() |
bool | Identical
(
const FConstSharedStruct* Other, |
For StructOpsTypeTraits |
![]() |
void | InitializeAs
(
const UScriptStruct* InScriptStruct, |
Initializes from struct type and optional data. |
![]() |
void | InitializeAs
(
TArgs&&... InArgs |
Initializes from struct type and emplace args. |
![]() |
void | InitializeAs
(
const T& Struct |
Initializes from other related struct types. |
![]() |
void | InitializeAs () |
Initializes from templated struct type. |
![]() |
void | InitializeAs
(
const T& Struct |
Initializes from templated struct instance. |
![]() ![]() |
bool | IsValid () |
Returns True if the struct is valid. |
![]() ![]() |
FConstSharedStruct | Make () |
Creates a new FSharedStruct from templated struct type. |
![]() ![]() |
FConstSharedStruct | Make
(
const T& Struct |
Creates a new FSharedStruct from templated struct instance. |
![]() ![]() |
FConstSharedStruct | Make
(
TArgs&&... InArgs |
Creates a new FSharedStruct from the templated type and forward all arguments to constructor. |
![]() ![]() |
FConstSharedStruct | Make
(
const UScriptStruct* InScriptStruct, |
Creates a new FSharedStruct from struct type and optional data. |
![]() |
void | Reset () |
Reset to empty. |
Operators
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | operator!=
(
const OtherType& Other |
|
![]() |
FConstSharedStruct & | operator=
(
const FConstSharedStruct& Other |
|
![]() |
FConstSharedStruct & | operator=
(
const FSharedStruct& SharedStruct |
|
![]() |
FConstSharedStruct & | operator=
(
FSharedStruct&& InSharedStruct |
|
![]() |
FConstSharedStruct & | operator=
(
FConstSharedStruct&& Other |
|
![]() ![]() |
bool | operator==
(
const OtherType& Other |
Comparison operators. Note: it does not compare the internal structure itself |