1. Epic GamesDeveloper
  3. FInstancedStruct

FInstancedStruct

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

API > API/Runtime > API/Runtime/CoreUObject

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

Example:

FInstancedStructTest;

TArray TestArray;

   
Name FInstancedStruct
Type struct
Header File /Engine/Source/Runtime/CoreUObject/Public/StructUtils/InstancedStruct.h
Include Path #include "StructUtils/InstancedStruct.h"

Syntax

USTRUCT (BlueprintType ,  
        Meta=(DisableSplitPin, HasNativeMake="/Script/Engine.BlueprintInstancedStructLibrary.MakeInstancedStruct"))  
struct FInstancedStruct

Constructors

Name Remarks Include Path Unreal Specifiers
  StructUtils/InstancedStruct.h  

FInstancedStruct ( const FInstancedStruct& InOther
)

   StructUtils/InstancedStruct.h  
  StructUtils/InstancedStruct.h  

FInstancedStruct ( const UScriptStruct* InScriptStruct,
uint8* InStructMemory
)

   StructUtils/InstancedStruct.h  

FInstancedStruct ( const UScriptStruct* InScriptStruct
)

   StructUtils/InstancedStruct.h  
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). StructUtils/InstancedStruct.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FInstancedStruct()

   StructUtils/InstancedStruct.h  

Typedefs

Name Type Remarks Include Path
FNetSerializeInstancedStruct TBaseDelegate_ThreeParams< bool, FInstancedStruct &, FArchive &, UPackageMap * >   StructUtils/InstancedStruct.h

Constants

Name Type Remarks Include Path
NetSerializeScriptStructDelegate FNetSerializeInstancedStruct   StructUtils/InstancedStruct.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
)

   StructUtils/InstancedStruct.h  

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

   StructUtils/InstancedStruct.h  

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

   StructUtils/InstancedStruct.h  

const T & Get()

 Returns const reference to the struct, this getter assumes that all data is valid. StructUtils/InstancedStruct.h  

const uint8 * GetMemory()

 Returns const pointer to struct memory. StructUtils/InstancedStruct.h  

T & GetMutable()

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

uint8 * GetMutableMemory()

 Returns a mutable pointer to struct memory. StructUtils/InstancedStruct.h  

T * GetMutablePtr()

 Returns mutable pointer to the struct, or nullptr if cast is not valid. StructUtils/InstancedStruct.h  

void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   StructUtils/InstancedStruct.h  

const T * GetPtr()

 Returns const pointer to the struct, or nullptr if cast is not valid. StructUtils/InstancedStruct.h  

const UScriptStruct * GetScriptStruct()

 Returns struct type. StructUtils/InstancedStruct.h  

bool Identical ( const FInstancedStruct* Other,
uint32 PortFlags
) const

   StructUtils/InstancedStruct.h  

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

   StructUtils/InstancedStruct.h  

T & InitializeAs ( TArgs&&... InArgs
)

 Initializes from struct type and emplace construct. StructUtils/InstancedStruct.h  

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

 Initializes from struct type and optional data. StructUtils/InstancedStruct.h  

bool IsValid()

 Returns True if the struct is valid. StructUtils/InstancedStruct.h  

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

   StructUtils/InstancedStruct.h  

void ReplaceScriptStructInternal ( const UScriptStruct* NewStruct
)

 Internal method used to replace the script struct during user defined struct instantiation. StructUtils/InstancedStruct.h  

void Reset()

 Reset to empty. StructUtils/InstancedStruct.h  

void * ResolveVisitedPathInfo ( const FPropertyVisitorInfo& Info
) const

   StructUtils/InstancedStruct.h  

bool Serialize ( FArchive& Ar,
UStruct* DefaultsStruct,
const void* Defaults
)

 For StructOpsTypeTraits StructUtils/InstancedStruct.h  

bool SerializeFromMismatchedTag ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot
)

   StructUtils/InstancedStruct.h  
  StructUtils/InstancedStruct.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ResetStructData()

   StructUtils/InstancedStruct.h  

void SetStructData ( const UScriptStruct* InScriptStruct,
uint8* InStructMemory
)

   StructUtils/InstancedStruct.h  

Static

Name Remarks Include Path Unreal Specifiers

static FInstancedStruct Make ( TArgs&&... InArgs
)

 Creates a new FInstancedStruct from the templated type and forward all arguments to constructor. StructUtils/InstancedStruct.h  
Creates a new FInstancedStruct from templated struct type. StructUtils/InstancedStruct.h  

static FInstancedStruct Make ( const T& Struct
)

 Creates a new FInstancedStruct from templated struct. StructUtils/InstancedStruct.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FInstancedStruct& Other
) const

   StructUtils/InstancedStruct.h  
  StructUtils/InstancedStruct.h  
  StructUtils/InstancedStruct.h  
  StructUtils/InstancedStruct.h  

bool operator== ( const FInstancedStruct& Other
) const

 Comparison operators. Deep compares the struct instance when identical. StructUtils/InstancedStruct.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page