UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FOverlapInfo Struct Reference

#include <OverlapInfo.h>

Public Member Functions

 FOverlapInfo ()
 
 FOverlapInfo (const FHitResult &InSweepResult)
 
ENGINE_API FOverlapInfo (UPrimitiveComponent *InComponent, int32 InBodyIndex=INDEX_NONE)
 
int32 GetBodyIndex () const
 

Public Attributes

bool bFromSweep = false
 
FHitResult OverlapInfo
 

Friends

bool operator== (const FOverlapInfo &LHS, const FOverlapInfo &RHS)
 

Detailed Description

Overlap info consisting of the primitive and the body that is overlapping

Constructor & Destructor Documentation

◆ FOverlapInfo() [1/3]

FOverlapInfo::FOverlapInfo ( )
inline

◆ FOverlapInfo() [2/3]

FOverlapInfo::FOverlapInfo ( const FHitResult InSweepResult)
inlineexplicit

◆ FOverlapInfo() [3/3]

FOverlapInfo::FOverlapInfo ( UPrimitiveComponent *  InComponent,
int32  InBodyIndex = INDEX_NONE 
)
explicit

Member Function Documentation

◆ GetBodyIndex()

int32 FOverlapInfo::GetBodyIndex ( ) const
inline

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const FOverlapInfo LHS,
const FOverlapInfo RHS 
)
friend

Member Data Documentation

◆ bFromSweep

bool FOverlapInfo::bFromSweep = false

◆ OverlapInfo

FHitResult FOverlapInfo::OverlapInfo

Information for both sweep and overlap queries. Different parts are valid depending on bFromSweep. If bFromSweep is true then FHitResult is completely valid just like a regular sweep result. If bFromSweep is false only FHitResult::Component, FHitResult::Actor, FHitResult::Item are valid as this is really just an FOverlapResult


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