FCollisionQueryParams

Inheritance Hierarchy

FCollisionQueryParams

FComponentQueryParams

Syntax

struct FCollisionQueryParams

Remarks

Structure that defines parameters passed into collision function

Variables

Name Description

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

 

bTraceComplex

Whether we should trace against complex collision

Public variable

FMaskFilter

 

IgnoreMask

Extra filtering done on the query. See declaration for filtering logic

Public variable

EQueryMobilityT ...

 

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

Name Description

Public function

FCollisionQueryParams()

Public function

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

Public function

FCollisionQueryParams

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

Public function

FCollisionQueryParams

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

Functions

Name Description

Public function

void

 

AddIgnoredActor

(
    const uint32 InIgnoreActorID
)

Add an actor by ID for this trace to ignore

Public function

void

 

AddIgnoredActor

(
    const AActor * InIgnoreActor
)

Add an actor for this trace to ignore

Public function

void

 

AddIgnoredActors

(
    const TArray < TWeakObjectPtr < const...
)

Variant that uses an array of TWeakObjectPtrs

Public function

void

 

AddIgnoredActors

(
    const TArray < const AActor * > ...
)

Add a collection of actors for this trace to ignore

Public function

void

 

AddIgnoredActors

(
    const TArray < AActor * >& InIg...
)

Add a collection of actors for this trace to ignore

Public function

void

 

AddIgnoredComponent

(
    const UPrimitiveComponent * InI...
)

Add a component for this trace to ignore

Public function

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.

Public function

void

 

AddIgnoredComponents

(
    const TArray < UPrimitiveComponent &...
)

Add a collection of components for this trace to ignore

Public function

void

 

AddIgnoredComponents

(
    const TArray < TWeakObjectPtr < UPrim ...
)

Variant that uses an array of TWeakObjectPtrs

Public function

void

 

ClearIgnoredComponents()

Clears the set of components to ignore during the trace.

Public function Const

const Ignore ...

 

GetIgnoredActors()

Returns set of actors to ignore during the trace.

Public function Const

const Ignore ...

 

GetIgnoredComponents()

Returns set of unique components to ignore during the trace.

Public function Static

TStatId

 

GetUnknownStatId()

Public function

void

 

SetNumIgnoredComponents

(
    int32 NewNum
)

Set the number of ignored components in the list.

Public function Const

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

Public function

 

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

References

Module

Engine

Header

Runtime/Engine/Public/CollisionQueryParams.h