TEntityRange | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/EntitySystem

Inheritance Hierarchy

TEntityRangeImpl
TEntityRange

References


Module	MovieScene
Header	/Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityRange.h
Include	#include "EntitySystem/MovieSceneEntityRange.h"

Syntax

template<typename... T>  
struct TEntityRange : public UE::MovieScene::TEntityRangeImpl< TMakeIntegerSequence< int, sizeof...(T)>, T... >

Remarks

Variadic template representing a contiguous range of entities with a specific set of components

The template parameters define each component type by index, whose constness should match the read/write semantics of the accessor. For example, an entity with a float, int and bool component, accessed read-only should be represented by a TEntityRange. If one wished to write to all the float components, we would require a TEntityRange etc

Constructors

	Type	Name	Description
		TEntityRange ()	Default constructor - empty range
		TEntityRange ( int32 InNum )	Constructor that initializes the size, but no component ptrs.
		TEntityRange ( int32 InNum, T*... InComponentArrays )	Constructor that initializes the size and components for this range

Functions

Type	Name	Description
TEntityPtr< T... >	begin ()
TEntityPtr< T... >	end ()
auto	GetAll ()	Get all the components for the templated index as a TArrayView.
auto &	GetComponent ( int32 EntityIndex )	Get the component from the templated component array index, using its index within this range.
auto *&	GetComponentArrayReference ()	Return a reference to the component array pointer at the specified index.
auto *	GetComponentOptional ( int32 EntityIndex )	Get a pointer to an entity's component from its templated component array index, using the entity's index within this range.
auto *	GetRawUnchecked ()	Retrieve the raw pointer to the (possibly nullptr) component array at the templated index.
int32	Num ()	Access the size of this range
void	SetComponent ( int32 EntityIndex, ValueType&& InValue )	Assign the value of an entity's component from its templated component array index, using the entity's index within this range.