FOverlapResult Struct Reference

#include <OverlapResult.h>

Public Member Functions
UE_INTERNAL int32	GetItemIndexInternal () const
ENGINE_API int32	GetItemIndex () const
ENGINE_API void	SetItemIndex (const int32 InItemIndex)
AActor *	GetActor () const
UPrimitiveComponent *	GetComponent () const
	FOverlapResult ()

Public Attributes
FActorInstanceHandle	OverlapObjectHandle
TWeakObjectPtr< class UPrimitiveComponent >	Component
int32	ItemIndex
TWeakObjectPtr< UObject >	PhysicsObjectOwner
Chaos::FPhysicsObjectHandle	PhysicsObject
uint32	bBlockingHit: 1

Detailed Description

Structure containing information about one hit of an overlap test

Constructor & Destructor Documentation

FOverlapResult()

FOverlapResult::FOverlapResult ( )

inline

Member Function Documentation

GetActor()

AActor * FOverlapResult::GetActor ( ) const

inline

Utility to return the Actor that owns the Component that was hit

GetComponent()

UPrimitiveComponent * FOverlapResult::GetComponent ( ) const

inline

Utility to return the Component that was hit

GetItemIndex()

int32 FOverlapResult::GetItemIndex

(

)

const

GetItemIndexInternal()

int32 FOverlapResult::GetItemIndexInternal

(

)

const

SetItemIndex()

void FOverlapResult::SetItemIndex

(

const int32

InItemIndex

)

Member Data Documentation

bBlockingHit

uint32 FOverlapResult::bBlockingHit

Indicates if this hit was requesting a block - if false, was requesting a touch instead

Component

TWeakObjectPtr<class UPrimitiveComponent> FOverlapResult::Component

PrimitiveComponent that the check hit.

ItemIndex

int32 FOverlapResult::ItemIndex

This is the index of the overlapping item. For DestructibleComponents, this is the ChunkInfo index. For SkeletalMeshComponents this is the Body index or INDEX_NONE for single body

OverlapObjectHandle

FActorInstanceHandle FOverlapResult::OverlapObjectHandle

PhysicsObject

Chaos::FPhysicsObjectHandle FOverlapResult::PhysicsObject

PhysicsObjects hit by the query. Not exposed to blueprints for the time being

PhysicsObjectOwner

TWeakObjectPtr<UObject> FOverlapResult::PhysicsObjectOwner

The object that owns the PhysicsObject. This is used to determine if the PhysicsObject is still valid when not owned by an Actor

---

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

• Engine/Source/Runtime/Engine/Classes/Engine/OverlapResult.h
• Engine/Source/Runtime/Engine/Private/Engine/OverlapResult.cpp