1. Epic GamesDeveloper
  3. FInstancedStructContainer

FInstancedStructContainer

Array of heterogeneous structs.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/StructUtils

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/StructUtils/InstancedStructContainer.h
Include #include "StructUtils/InstancedStructContainer.h"

Syntax

USTRUCT ()  
struct FInstancedStructContainer

Remarks

Array of heterogeneous structs. Can be used as a property, supports serialization, but does not have type customizations (no editing in the UI).

If you need UI editable array of heterogeneous structs, use TArray instead.

The array item values and the index to an item are stored in one contiguous block of memory. The size required to specific layout of structs is larger than the sum of their sizes due to alignment, and because the index to the structs is stored along with the value memory. Each item takes extra 16 bytes for index. If your items are roughly same size, a TArray> might be more performant.

Adding new items is more expensive than on regular TArray<>, layout of the structs needs to be updated, and initialization is done via UScriptStruct. Adding and removing items should be done in chunks if possible.

The allocation of new items does not allocate extra space as most array implementations do. Use Reserve() to reserve certain sized buffer in bytes if that is applicable to your use case.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Type traits
Public function void

Append ( TConstArrayView< FConstStructView > NewItemValues
)

  
Public function void Appends items to the array.
Public function void

Append ( TConstArrayView< FInstancedStruct > NewItemValues
)

  
Public function FIterator

begin ()

 For ranged for, do not use directly.
Public function Const FConstIterator

begin ()

  
Public function Const FConstIterator Creates const iterator to iterate over the array.
Public function FIterator Creates iterator to iterate over the array.
Public function void

Empty ()

 Empties the array, destroys entities. Frees memory.
Public function Const FConstIterator

end ()

  
Public function FIterator

end ()

  
Public function Const bool

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

  
Public function Const int32 Returns number of bytes allocated for the array
Public function Const void  
Public function Const bool

Identical ( const FInstancedStructContainer* Other,
uint32 PortFlags
)

  
Public function bool

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

  
Public function void

InsertAt ( const int32 InsertAtIndex,
TConstArrayView< FStructView > ValuesToInsert
)

  
Public function void

InsertAt ( const int32 InsertAtIndex,
const FInstancedStructContainer& Other
)

 Insert new items at specified location.
Public function void

InsertAt ( const int32 InsertAtIndex,
TConstArrayView< FInstancedStruct > ValuesToInsert
)

  
Public function void

InsertAt ( const int32 InsertAtIndex,
TConstArrayView< FConstStructView > ValuesToInsert
)

  
Public function Const bool

IsValid ()

  
Public function Const bool

IsValidIndex ( const int32 Index
)

  
Public function Const int32

Num ()

  
Public function void

RemoveAt ( const int32 RemoveAtIndex,
const int32 Count
)

 Remove items at specific location. Does not change memory allocation.
Public function void

ReserveBytes ( const int32 NumBytes,
const int32 MinAlignment
)

 Reserves at least 'NumBytes' for internal storage.
Public function void

Reset ()

 Empties the array, destroys entities. Does not change memory allocation.
Public function bool  
Public function void

SetNum ( const int32 NewNum
)

 Sets the number of items in the array.

Operators

  Type Name Description
Public function Const FConstStructView

operator[] ( const int32 Index
)

  
Public function FStructView

operator[] ( const int32 Index
)

  
Public function FInstancedStructContainer &  
Public function FInstancedStructContainer &  
Public function FInstancedStructContainer &

operator= ( TConstArrayView< FInstancedStruct > InItems
)

  
Public function FInstancedStructContainer &

operator= ( TConstArrayView< FConstStructView > InItems
)

  
Public function FInstancedStructContainer &

operator= ( TConstArrayView< FStructView > InItems
)

  

Classes

  Type Name Description
Public struct TIterator Iterators to enable range-based for loop support.  

Typedefs

Name Description
FConstIterator  
FIterator  

Constants

Name Description
DefaultMinAlignment Default minimum alignment for any allocation.
ItemStride Each FItem struct is allocated at the end of the buffer (which is aligned to FItem alignment), and they are stride apart.
OverheadPerItem How much memory is used to store info about each item.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page