Navigation
API > API/Runtime > API/Runtime/CoreUObject
FScriptArrayHelper: Pseudo dynamic array. Used to work with array properties in a sensible way.
| Name | FScriptArrayHelper |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h |
| Include Path | #include "UObject/UnrealType.h" |
Syntax
class FScriptArrayHelper
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScriptArrayHelper
(
const FArrayProperty* InProperty, |
Constructor, brings together a property and an instance of the property located in memory | UObject/UnrealType.h | |
FScriptArrayHelper
(
EInternal, |
UObject/UnrealType.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FreezableArray | FFreezableScriptArray * | UObject/UnrealType.h | ||
| HeapArray | FScriptArray * | UObject/UnrealType.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArrayFlags | EArrayPropertyFlags | UObject/UnrealType.h | ||
| ElementAlignment | uint32 | UObject/UnrealType.h | ||
| ElementSize | int32 | UObject/UnrealType.h | ||
| FScriptArrayHelper | union FScriptArrayHelper | UObject/UnrealType.h | ||
| InnerProperty | const FProperty * | UObject/UnrealType.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddUninitializedValue() |
Add an uninitialized value to the end of the array. | UObject/UnrealType.h | |
int32 AddUninitializedValues
(
int32 Count |
Add uninitialized values to the end of the array. | UObject/UnrealType.h | |
int32 AddValue() |
Add a blank, constructed values to the end of the array. | UObject/UnrealType.h | |
int32 AddValues
(
int32 Count |
Add blank, constructed values to the end of the array. | UObject/UnrealType.h | |
void ClearValues
(
int32 Index, |
Clear values in the array. The meaning of clear is defined by the property system. | UObject/UnrealType.h | |
void CountBytes
(
FArchive& Ar |
Used by memory counting archives to accumulate the size of this array. | UObject/UnrealType.h | |
void DestroyContainer_Unsafe() |
Destroys the container object - THERE SHOULD BE NO MORE USE OF THIS HELPER AFTER THIS FUNCTION IS CALLED! | UObject/UnrealType.h | |
void EmptyAndAddUninitializedValues
(
int32 Count |
Empty the array, then add uninitialized values to a given size. | UObject/UnrealType.h | |
void EmptyAndAddValues
(
int32 Count |
Empty the array, then add blank, constructed values to a given size. | UObject/UnrealType.h | |
void EmptyValues
(
int32 Slack |
Remove all values from the array, calling destructors, etc as appropriate. | UObject/UnrealType.h | |
bool ExpandForIndex
(
int32 Index |
Expand the array, if needed, so that the given index is valid | UObject/UnrealType.h | |
uint8 * GetElementPtr
(
int32 Index |
Returns a uint8 pointer to an element in the array. | UObject/UnrealType.h | |
uint8 * GetRawPtr
(
int32 Index |
Returns a uint8 pointer to an element in the array | UObject/UnrealType.h | |
void InsertValues
(
int32 Index, |
Insert blank, constructed values into the array. | UObject/UnrealType.h | |
bool IsValidIndex
(
int32 Index |
Index range check | UObject/UnrealType.h | |
void MoveAssign
(
void* InOtherArray |
Move the allocation from another array and make it our own. | UObject/UnrealType.h | |
int32 Num() |
Return the number of elements in the array. | UObject/UnrealType.h | |
int32 NumUnchecked () |
Return the number of elements in the array without validating the state of the array. | UObject/UnrealType.h | |
void RemoveValues
(
int32 Index, |
Remove values from the array, calling destructors, etc as appropriate. | UObject/UnrealType.h | |
void Resize
(
int32 Count |
Add or remove elements to set the array to a given size. | UObject/UnrealType.h | |
void SwapValues
(
int32 A, |
Swap two elements in the array, does not call constructors and destructors | UObject/UnrealType.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FScriptArrayHelper CreateHelperFormInnerProperty
(
const FProperty* InInnerProperty, |
UObject/UnrealType.h |