UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FComponentQueryParams Struct Reference

#include <CollisionQueryParams.h>

+ Inheritance diagram for FComponentQueryParams:

Public Member Functions

 FComponentQueryParams ()
 
 FComponentQueryParams (FName InTraceTag, const AActor *InIgnoreActor=NULL, const FCollisionEnabledMask InShapeCollisionMask=0)
 
 FComponentQueryParams (FName InTraceTag, const TStatId &InStatId, const AActor *InIgnoreActor=NULL, const FCollisionEnabledMask InShapeCollisionMask=0)
 
- Public Member Functions inherited from FCollisionQueryParams
ENGINE_API const IgnoreComponentsArrayTypeGetIgnoredComponents () const
 
const IgnoreActorsArrayTypeGetIgnoredActors () const
 
const IgnoreActorsArrayTypeGetIgnoredSourceObjects () const
 
void ClearIgnoredComponents ()
 
void ClearIgnoredActors ()
 
void ClearIgnoredSourceObjects ()
 
ENGINE_API void SetNumIgnoredComponents (int32 NewNum)
 
 FCollisionQueryParams ()
 
 FCollisionQueryParams (FName InTraceTag, bool bInTraceComplex=false, const AActor *InIgnoreActor=NULL)
 
ENGINE_API FCollisionQueryParams (FName InTraceTag, const TStatId &InStatId, bool bInTraceComplex=false, const AActor *InIgnoreActor=NULL)
 
ENGINE_API void AddIgnoredActor (const AActor *InIgnoreActor)
 
ENGINE_API void AddIgnoredActor (const uint32 InIgnoreActorID)
 
ENGINE_API void AddIgnoredSourceObject (const UObject *InIgnoreActor)
 
ENGINE_API void AddIgnoredSourceObject (const TWeakObjectPtr< const UObject > &InIgnoreObject)
 
ENGINE_API void AddIgnoredSourceObject (const FRemoteObjectReference &ObjectRef)
 
ENGINE_API void AddIgnoredSourceObject (const uint32 InIgnoreActorID)
 
ENGINE_API void AddIgnoredActors (const TArray< AActor * > &InIgnoreActors)
 
ENGINE_API void AddIgnoredActors (const TArray< const AActor * > &InIgnoreActors)
 
ENGINE_API void AddIgnoredActors (const TArray< TWeakObjectPtr< const AActor > > &InIgnoreActors)
 
ENGINE_API void AddIgnoredSourceObjects (const TArray< UObject * > &InIgnoreObjects)
 
ENGINE_API void AddIgnoredSourceObjects (const TArray< const UObject * > &InIgnoreObjects)
 
ENGINE_API void AddIgnoredSourceObjects (const TArray< TWeakObjectPtr< const UObject > > &InIgnoreObjects)
 
ENGINE_API void AddIgnoredComponent (const UPrimitiveComponent *InIgnoreComponent)
 
ENGINE_API void AddIgnoredComponent (const TWeakObjectPtr< UPrimitiveComponent > &InIgnoreComponent)
 
ENGINE_API void AddIgnoredComponent (const FRemoteObjectReference &InComponentRef)
 
ENGINE_API void AddIgnoredComponents (const TArray< UPrimitiveComponent * > &InIgnoreComponents)
 
ENGINE_API void AddIgnoredComponents (const TArray< TWeakObjectPtr< UPrimitiveComponent > > &InIgnoreComponents)
 
ENGINE_API void AddIgnoredComponent_LikelyDuplicatedRoot (const UPrimitiveComponent *InIgnoreComponent)
 
UE_INTERNAL ENGINE_API void Internal_AddIgnoredComponent (const uint32 ComponentID)
 
FString ToString () const
 

Public Attributes

FCollisionEnabledMask ShapeCollisionMask
 
- Public Attributes inherited from FCollisionQueryParams
FName TraceTag
 
FName OwnerTag
 
bool bTraceComplex
 
bool bFindInitialOverlaps
 
bool bReturnFaceIndex
 
bool bReturnPhysicalMaterial
 
bool bIgnoreBlocks
 
bool bIgnoreTouches
 
bool bSkipNarrowPhase
 
bool bTraceIntoSubComponents
 
bool bReplaceHitWithSubComponents
 
EQueryMobilityType MobilityType
 
FMaskFilter IgnoreMask
 
TStatId StatId
 
bool bDebugQuery
 

Static Public Attributes

static ENGINE_API FComponentQueryParams DefaultComponentQueryParams
 
- Static Public Attributes inherited from FCollisionQueryParams
static ENGINE_API FCollisionQueryParams DefaultQueryParam
 

Additional Inherited Members

- Public Types inherited from FCollisionQueryParams
typedef TArray< uint32, TInlineAllocator< 8 > > IgnoreComponentsArrayType
 
typedef TArray< uint32, TInlineAllocator< 4 > > IgnoreSourceObjectsArrayType
 
typedef IgnoreSourceObjectsArrayType IgnoreActorsArrayType
 
- Static Public Member Functions inherited from FCollisionQueryParams
static TStatId GetUnknownStatId ()
 

Detailed Description

Structure when performing a collision query using a component's geometry

Constructor & Destructor Documentation

◆ FComponentQueryParams() [1/3]

FComponentQueryParams::FComponentQueryParams ( )
inline

◆ FComponentQueryParams() [2/3]

FComponentQueryParams::FComponentQueryParams ( FName  InTraceTag,
const AActor InIgnoreActor = NULL,
const FCollisionEnabledMask  InShapeCollisionMask = 0 
)
inline

◆ FComponentQueryParams() [3/3]

FComponentQueryParams::FComponentQueryParams ( FName  InTraceTag,
const TStatId InStatId,
const AActor InIgnoreActor = NULL,
const FCollisionEnabledMask  InShapeCollisionMask = 0 
)
inline

Member Data Documentation

◆ DefaultComponentQueryParams

FComponentQueryParams FComponentQueryParams::DefaultComponentQueryParams
static

static variable for default data to be used without reconstructing everytime

◆ ShapeCollisionMask

FCollisionEnabledMask FComponentQueryParams::ShapeCollisionMask

Only use query shapes which remain unmasked by this collision mask (if mask is nonzero)


The documentation for this struct was generated from the following files: