1. Epic GamesDeveloper
  3. FCollisionQueryParams

FCollisionQueryParams

Structure that defines parameters passed into collision function

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function   Constructors.
Public function  

FCollisionQueryParams ( FName InTraceTag,
bool bInTraceComplex,
const AActor* InIgnoreActor
)

  
Public function  

FCollisionQueryParams ( FName InTraceTag,
const TStatId& InStatId,
bool bInTraceComplex,
const AActor* InIgnoreActor
)

  

Functions

  Type Name Description
Public function void

AddIgnoredActor ( const AActor* InIgnoreActor
)

 Add an actor for this trace to ignore
Public function void

AddIgnoredActor ( const uint32 InIgnoreActorID
)

 Add an actor by ID for this trace to ignore
Public function void

AddIgnoredActors ( const TArray< TWeakObjectPtr< const AActor > >& InIgnoreActors
)

 Variant that uses an array of TWeakObjectPtrs
Public function void

AddIgnoredActors ( const TArray< const AActor* >& InIgnoreActors
)

 Add a collection of actors for this trace to ignore
Public function void

AddIgnoredActors ( const TArray< AActor* >& InIgnoreActors
)

 Add a collection of actors for this trace to ignore
Public function void

AddIgnoredComponent ( const UPrimitiveComponent* InIgnoreComponent
)

 Add a component for this trace to ignore
Public function void Special variant that hints that we are likely adding a duplicate of the root component or first ignored component.
Public function void

AddIgnoredComponents ( const TArray< UPrimitiveComponent* >& InIgnoreComponents
)

 Add a collection of components for this trace to ignore
Public function void

AddIgnoredComponents ( const TArray< TWeakObjectPtr< UPrimitiveComponent >>& InIgnoreComponents
)

 Variant that uses an array of TWeakObjectPtrs
Public function void Clears the set of actors to ignore during the trace.
Public function void Clears the set of components to ignore during the trace.
Public function Const const IgnoreActorsArrayType & Returns set of actors to ignore during the trace.
Public function Const const IgnoreComponentsArrayType & Returns set of unique components to ignore during the trace.
Public function Static TStatId  
Public function void

SetNumIgnoredComponents ( int32 NewNum
)

 Set the number of ignored components in the list.
Public function Const FString  

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page