AActor::GetComponents

[UActorComponent](API\Runtime\Engine\Components\UActorComponent) specialization of [GetComponents()](API\Runtime\Engine\GameFramework\AActor\GetComponents\4) to avoid unnecessary casts.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/Actor.h

Include

#include "GameFramework/Actor.h"

Syntax

template<class AllocatorType>
void GetComponents
(
    TArray< UActorComponent *, AllocatorType > & OutComponents,
    bool bIncludeFromChildActors
) const

Remarks

UActorComponent specialization of GetComponents() to avoid unnecessary casts. It's recommended to use TArrays with a TInlineAllocator to potentially avoid memory allocation costs. TInlineComponentArray is defined to make this easier, for example: { TInlineComponentArray PrimComponents; Actor->GetComponents(PrimComponents); }

Parameters

Parameter

Description

bIncludeFromChildActors

If true then recurse in to ChildActor components and find components of the appropriate type in those Actors as well

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss