Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FCollisionQueryParams

Light Theme

Dark Theme

FCollisionQueryParams

Structure that defines parameters passed into collision function

Windows

MacOS

Linux

Inheritance Hierarchy

FCollisionQueryParams

FComponentQueryParams

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/CollisionQueryParams.h
Include	#include "CollisionQueryParams.h"

Syntax

struct FCollisionQueryParams

Remarks

Structure that defines parameters passed into collision function

Variables

	Name	Description
bool	bDebugQuery
bool	bFindInitialOverlaps	Whether we want to find out initial overlap or not.
bool	bIgnoreBlocks	Whether to ignore blocking results.
bool	bIgnoreTouches	Whether to ignore touch/overlap results.
bool	bReturnFaceIndex	Whether we want to return the triangle face index for complex static mesh traces
bool	bReturnPhysicalMaterial	Whether we want to include the physical material in the results.
bool	bSkipNarrowPhase	Whether to skip narrow phase checks (only for overlaps).
bool	bTraceComplex	Whether we should trace against complex collision
FMaskFilter	IgnoreMask	Extra filtering done on the query. See declaration for filtering logic
EQueryMobilityT...	MobilityType	Filters query by mobility types (static vs stationary/movable)
FName	OwnerTag	Tag used to indicate an owner for this trace
TStatId	StatId	StatId used for profiling individual expensive scene queries
FName	TraceTag	Tag used to provide extra information or filtering for debugging of the trace (e.g. Collision Analyzer)

Constructors

	Name	Description
	FCollisionQueryParams()
	FCollisionQueryParams ( bool bInTraceComplex )	FCollisionQueryParams, to avoid ambiguity, please use other constructor and explicitly provide an FName parameter (not just a string literal) as the first parameter
	FCollisionQueryParams ( FName InTraceTag, bool bInTraceComplex, const AActor* InIgnoreActor )
	FCollisionQueryParams ( FName InTraceTag, const TStatId& InStatId, bool bInTraceComplex, const AActor* InIgnoreActor )

Functions

	Name	Description
void	AddIgnoredActor ( const AActor* InIgnoreActor )	Add an actor for this trace to ignore
void	AddIgnoredActor ( const uint32 InIgnoreActorID )	Add an actor by ID for this trace to ignore
void	AddIgnoredActors ( const TArray< TWeakObjectPtr< const... )	Variant that uses an array of TWeakObjectPtrs
void	AddIgnoredActors ( const TArray< const AActor* > ... )	Add a collection of actors for this trace to ignore
void	AddIgnoredActors ( const TArray< AActor* >& InIg... )	Add a collection of actors for this trace to ignore
void	AddIgnoredComponent ( const UPrimitiveComponent* InI... )	Add a component for this trace to ignore
void	AddIgnoredComponent_LikelyDuplicatedRoot ( const UPrimitiveComponent* InI... )	Special variant that hints that we are likely adding a duplicate of the root component or first ignored component.
void	AddIgnoredComponents ( const TArray< UPrimitiveComponent&... )	Add a collection of components for this trace to ignore
void	AddIgnoredComponents ( const TArray< TWeakObjectPtr< UPrim... )	Variant that uses an array of TWeakObjectPtrs
void	ClearIgnoredActors()	Clears the set of actors to ignore during the trace.
void	ClearIgnoredComponents()	Clears the set of components to ignore during the trace.
const Ignore...	GetIgnoredActors()	Returns set of actors to ignore during the trace.
const Ignore...	GetIgnoredComponents()	Returns set of unique components to ignore during the trace.
TStatId	GetUnknownStatId()
void	SetNumIgnoredComponents ( int32 NewNum )	Set the number of ignored components in the list.
FString	ToString()

Typedefs

Name	Description
IgnoreActorsArrayType	TArray typedef of actors to ignore.
IgnoreComponentsArrayType	TArray typedef of components to ignore.

Constants

Name	Description
DefaultQueryParam	Static variable for default data to be used without reconstructing everytime

Deprecated Functions

		Name	Description
		FCollisionQueryParams ( bool bInTraceComplex )	FCollisionQueryParams, to avoid ambiguity, please use other constructor and explicitly provide an FName parameter (not just a string literal) as the first parameter

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

Take our survey

Dismiss