1. Epic GamesDeveloper
  3. FInstancedStruct

FInstancedStruct

[FInstancedStruct](API\Plugins\StructUtils\FInstancedStruct) works similarly as instanced UObject* property but is USTRUCTs.

API > API/Plugins > API/Plugins/StructUtils

References

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

Syntax

USTRUCT&40;BlueprintType,  
        Meta&61;&40;HasNativeMake&61;"&47;Script&47;StructUtilsEngine.StructUtilsFunctionLibrary.MakeInstancedStruct"&41;&41;  
struct FInstancedStruct

Remarks

FInstancedStruct works similarly as instanced UObject* property but is USTRUCTs.

Example:

FInstancedStructTest;

TArray TestArray;

Variables

  Type Name Description
Protected variable TObjectPtr< const UScriptStruct > ScriptStruct  
Protected variable uint8 * StructMemory  

Constructors

  Type Name Description
Public function    
Public function  

FInstancedStruct ( const UScriptStruct* InScriptStruct
)

  
Public function   This constructor is explicit to avoid accidentally converting struct views to instanced structs (which would result in costly copy of the struct to be made).
Public function  

FInstancedStruct ( const FInstancedStruct& InOther
)

  
Public function    
Protected function  

FInstancedStruct ( const UScriptStruct* InScriptStruct,
uint8* InStructMemory
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const bool

ExportTextItem ( FString& ValueStr,
FInstancedStruct const& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
)

  
Public function Const bool

FindInnerPropertyInstance ( FName PropertyName,
const FProperty*& OutProp,
const void*& OutData
)

  
Public function Const const T &

Get ()

 Returns const reference to the struct, this getter assumes that all data is valid.
Public function Const const uint8 * Returns const pointer to struct memory.
Public function T & Returns mutable reference to the struct, this getter assumes that all data is valid.
Public function uint8 * Returns a mutable pointer to struct memory.
Public function T * Returns mutable pointer to the struct, or nullptr if cast is not valid.
Public function void  
Public function Const const T *

GetPtr ()

 Returns const pointer to the struct, or nullptr if cast is not valid.
Public function Const const UScriptStruct * Returns struct type.
Public function Const bool

Identical ( const FInstancedStruct* Other,
uint32 PortFlags
)

  
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText,
FArchive* InSerializingArchive
)

  
Public function void

InitializeAs ( TArgs&&... InArgs
)

 Initializes from struct type and emplace construct.
Public function void

InitializeAs ( const UScriptStruct* InScriptStruct,
const uint8* InStructMemory
)

 Initializes from struct type and optional data.
Public function Const bool

IsValid ()

 Returns True if the struct is valid.
Public function Static FInstancedStruct

Make ( TArgs&&... InArgs
)

 Creates a new FInstancedStruct from the templated type and forward all arguments to constructor.
Public function Static FInstancedStruct

Make ()

 Creates a new FInstancedStruct from templated struct type.
Public function Static FInstancedStruct

Make ( const T& Struct
)

 Creates a new FInstancedStruct from templated struct.
Public function bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

  
Public function void

Reset ()

 Reset to empty.
Protected function void  
Public function bool For StructOpsTypeTraits
Public function bool  
Protected function void

SetStructData ( const UScriptStruct* InScriptStruct,
uint8* InStructMemory
)

  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FInstancedStruct& Other
)

  
Public function FInstancedStruct &

operator= ( const FConstStructView InOther
)

  
Public function FInstancedStruct &

operator= ( FInstancedStruct&& InOther
)

  
Public function FInstancedStruct &

operator= ( const FInstancedStruct& InOther
)

  
Public function Const bool

operator== ( const FInstancedStruct& Other
)

 Comparison operators. Deep compares the struct instance when identical.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page