Navigation
API > API/Runtime > API/Runtime/Engine
Structure containing information about one hit of an overlap test
| Name | FOverlapResult |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/OverlapResult.h |
| Include Path | #include "Engine/OverlapResult.h" |
Syntax
USTRUCT ()
struct FOverlapResult
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOverlapResult() |
Engine/OverlapResult.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bBlockingHit | uint32 | Indicates if this hit was requesting a block - if false, was requesting a touch instead | Engine/OverlapResult.h | |
| Component | TWeakObjectPtr< class UPrimitiveComponent > | PrimitiveComponent that the check hit. | Engine/OverlapResult.h | |
| ItemIndex | int32 | This is the index of the overlapping item. | Engine/OverlapResult.h | |
| OverlapObjectHandle | FActorInstanceHandle | Engine/OverlapResult.h | ||
| PhysicsObject | Chaos::FPhysicsObjectHandle | PhysicsObjects hit by the query. Not exposed to blueprints for the time being | Engine/OverlapResult.h | |
| PhysicsObjectOwner | TWeakObjectPtr< UObject > | The object that owns the PhysicsObject. | Engine/OverlapResult.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AActor * GetActor() |
Utility to return the Actor that owns the Component that was hit | Engine/OverlapResult.h | |
UPrimitiveComponent * GetComponent() |
Utility to return the Component that was hit | Engine/OverlapResult.h | |
int32 GetItemIndex() |
Engine/OverlapResult.h | ||
int32 GetItemIndexInternal() |
Engine/OverlapResult.h | ||
void SetItemIndex
(
const int32 InItemIndex |
Engine/OverlapResult.h |