FConstStructArrayView | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/CoreUObject

A generic, transient view of a homogeneously-typed array of instances of a specific UScriptStruct FConstStructArrayView supplies immutable access to the elements of the Array. For a more indepth overview of the constness of views see FConstStructView


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

Syntax

struct FConstStructArrayView

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FConstStructArrayView ( const FStructArrayView Src )		StructUtils/StructArrayView.h
FConstStructArrayView ( TArrayView< T > InArrayView )		StructUtils/StructArrayView.h
FConstStructArrayView ( TArray< T >& InArray )		StructUtils/StructArrayView.h
FConstStructArrayView ()		StructUtils/StructArrayView.h
FConstStructArrayView ( const UScriptStruct& InScriptStruct, const void* InData, const int32 InCount )		StructUtils/StructArrayView.h
FConstStructArrayView ( const UScriptStruct* InScriptStruct, const void* InData, const uint32 InElementSize, const int32 InCount )		StructUtils/StructArrayView.h

Structs

Name	Remarks
FIterator

Variables

Protected

Name	Type	Include Path
ArrayNum	int32	StructUtils/StructArrayView.h
DataPtr	const void *	StructUtils/StructArrayView.h
ElementSize	uint32	StructUtils/StructArrayView.h
ScriptStruct	const UScriptStruct *	StructUtils/StructArrayView.h

Functions

Public

Name	Remarks	Include Path
FIterator begin()	Ranged iteration support. DO NOT USE DIRECTLY.	StructUtils/StructArrayView.h
void CheckInvariants()	Checks array invariants: if array size is greater than or equal to zero.	StructUtils/StructArrayView.h
FIterator end()		StructUtils/StructArrayView.h
TEnableIf< TIsConst< T >::Value, T & >::Type GetAt ( const int32 Index ) const	Returns reference to element at given index. Index and template param T MUST be must be valid.	StructUtils/StructArrayView.h
const void * GetData()	Helper function for returning a pointer to the first array entry.	StructUtils/StructArrayView.h
const void * GetDataAt ( const int32 Index ) const	Helper function for returning a pointer to an element in the array.	StructUtils/StructArrayView.h
TEnableIf< TIsConst< T >::Value, T * >::Type GetPtrAt ( const int32 Index ) const	Returns pointer to element at given index.	StructUtils/StructArrayView.h
const UScriptStruct * GetScriptStruct()	Returns struct type.	StructUtils/StructArrayView.h
uint32 GetTypeSize()	Helper function returning the size of the inner type.	StructUtils/StructArrayView.h
bool IsEmpty ()	Returns true if the array is empty and contains no elements.	StructUtils/StructArrayView.h
bool IsValidIndex ( int32 Index ) const	Tests if index is valid, i.e. greater than or equal to zero, and less than the number of elements in the array.	StructUtils/StructArrayView.h
TEnableIf< TIsConst< T >::Value, T & >::Type Last ( int32 IndexFromTheEnd ) const	Returns n-th last element from the array.	StructUtils/StructArrayView.h
FConstStructArrayView Left ( const int32 Count ) const	Returns the left-most part of the view by taking the given number of elements from the left.	StructUtils/StructArrayView.h
FConstStructArrayView LeftChop ( const int32 Count ) const	Returns the left-most part of the view by chopping the given number of elements from the right.	StructUtils/StructArrayView.h
void LeftChopInline ( const int32 Count )	Modifies the view by chopping the given number of elements from the right.	StructUtils/StructArrayView.h
void LeftInline ( const int32 Count )	Modifies the view to be the given number of elements from the left.	StructUtils/StructArrayView.h
FConstStructArrayView Mid ( int32 Index, int32 Count ) const	Returns the middle part of the view by taking up to the given number of elements from the given position.	StructUtils/StructArrayView.h
void MidInline ( const int32 Position, const int32 Count )	Modifies the view to be the middle part by taking up to the given number of elements from the given position.	StructUtils/StructArrayView.h
int32 Num()	Returns number of elements in array.	StructUtils/StructArrayView.h
void RangeCheck ( int32 Index ) const	Checks if index is in array range.	StructUtils/StructArrayView.h
FConstStructArrayView Right ( const int32 Count ) const	Returns the right-most part of the view by taking the given number of elements from the right.	StructUtils/StructArrayView.h
FConstStructArrayView RightChop ( const int32 Count ) const	Returns the right-most part of the view by chopping the given number of elements from the left.	StructUtils/StructArrayView.h
void RightChopInline ( const int32 Count )	Modifies the view by chopping the given number of elements from the left.	StructUtils/StructArrayView.h
void RightInline ( const int32 Count )	Modifies the view to be the given number of elements from the right.	StructUtils/StructArrayView.h
FConstStructArrayView Slice ( const int32 Index, const int32 InNum ) const	Returns a sliced view This is similar to Mid(), but with a narrow contract, i.e. slicing outside of the range of the view is illegal.	StructUtils/StructArrayView.h
void SliceRangeCheck ( int32 Index, int32 InNum ) const	Checks if a slice range [Index, Index+InNum) is in array range.	StructUtils/StructArrayView.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FConstStructView operator[] ( int32 Index ) const	Array bracket operator.	StructUtils/StructArrayView.h
FConstStructArrayView & operator= ( const FStructArrayView StructArrayView )		StructUtils/StructArrayView.h

Navigation