1. Epic GamesDeveloper
  3. FHitResult

FHitResult

Structure containing information about one hit of a trace, such as point of impact and surface normal at that point.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/HitResult.h
Include #include "Engine/HitResult.h"

Syntax

USTRUCT (BlueprintType ,  
        Meta=(HasNativeBreak="/Script/Engine.GameplayStatics.BreakHitResult", HasNativeMake="/Script/Engine.GameplayStatics.MakeHitResult"))  
struct FHitResult

Remarks

Structure containing information about one hit of a trace, such as point of impact and surface normal at that point.

Variables

  Type Name Description
Public variable UProperty uint8: 1 bBlockingHit Indicates if this hit was a result of blocking collision.
Public variable UProperty FName BoneName Name of bone we hit (for skeletal meshes).
Public variable UProperty uint8: 1 bStartPenetrating Whether the trace started in penetration, i.e. with an initial blocking overlap.
Public variable UProperty TWeakObjectPtr< UPrimitiveComponent > Component PrimitiveComponent hit by the trace.
Public variable UProperty float Distance The distance from the TraceStart to the Location in world space.
Public variable UProperty uint8 ElementIndex Index to item that was hit, also hit primitive specific.
Public variable UProperty int32 FaceIndex Face index we hit (for complex hits with triangle meshes).
Public variable UProperty FActorInstanceHandle HitObjectHandle Handle to the object hit by the trace.
Public variable UProperty FVector_NetQuantizeNormal ImpactNormal Normal of the hit in world space, for the object that was hit by the sweep, if any.
Public variable UProperty FVector_NetQuantize ImpactPoint Location in world space of the actual contact of the trace shape (box, sphere, ray, etc) with the impacted object.
Public variable UProperty int32 Item Extra data about item that was hit (hit primitive specific).
Public variable UProperty FVector_NetQuantize Location The location in world space where the moving shape would end up against the impacted object, if there is a hit.
Public variable UProperty notreplicated FName MyBoneName Name of the my bone which took part in hit event (in case of two skeletal meshes colliding).
Public variable UProperty notreplicated int32 MyItem If the hit result is from a collision this will have extra info about the item that hit the second item.
Public variable UProperty FVector_NetQuantizeNormal Normal Normal of the hit in world space, for the object that was swept.
Public variable UProperty float PenetrationDepth If this test started in penetration (bStartPenetrating is true) and a depenetration vector can be computed, this value is the distance along Normal that will result in moving out of penetration.
Public variable Chaos::FPhysicsObjectHandle PhysicsObject PhysicsObjects hit by the query. Not exposed to blueprints for the time being
Public variable TWeakObjectPtr< UObject > PhysicsObjectOwner The object that owns the PhysicsObject.
Public variable UProperty TWeakObjectPtr< UPhysicalMaterial > PhysMaterial Physical material that was hit.
Public variable UProperty float Time 'Time' of impact along trace direction (ranging from 0.0 to 1.0) if there is a hit, indicating time between TraceStart and TraceEnd.
Public variable UProperty FVector_NetQuantize TraceEnd End location of the trace; this is NOT where the impact occurred (if any), but the furthest point in the attempted sweep.
Public variable UProperty FVector_NetQuantize TraceStart Start location of the trace.

Constructors

  Type Name Description
Public function    
Public function  

FHitResult ( float InTime
)

  
Public function  

FHitResult ( EForceInit InInit
)

  
Public function  

FHitResult ( ENoInit NoInit
)

  
Public function  

FHitResult ( FVector Start,
FVector End
)

  
Public function  

FHitResult ( AActor* InActor,
UPrimitiveComponent* InComponent,
FVector const& HitLoc,
FVector const& HitNorm
)

 Ctor for easily creating "fake" hits from limited data.

Functions

  Type Name Description
Public function Const AActor * Utility to return the Actor that owns the Component that was hit.
Public function Const UPrimitiveComponent * Utility to return the Component that was hit.
Public function Static FHitResult * Static utility function that returns the first 'blocking' hit in an array of results.
Public function Const FActorInstanceHandle  
Public function Static int32

GetNumBlockingHits ( const TArray< FHitResult >& InHits
)

 Static utility function that returns the number of blocking hits in array.
Public function Static int32

GetNumOverlapHits ( const TArray< FHitResult >& InHits
)

 Static utility function that returns the number of overlapping hits in array.
Public function Static FHitResult

GetReversedHit ( const FHitResult& Hit
)

 Get a copy of the HitResult with relevant information reversed.
Public function Const bool  
Public function void

Init ( FVector Start,
FVector End
)

 Initialize empty hit result with given time, TraceStart, and TraceEnd
Public function void

Init ()

 Initialize empty hit result with given time.
Public function Const bool Return true if there was a blocking hit that was not caused by starting in penetration.
Public function bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

 Optimized serialize function
Public function void

Reset ( float InTime,
bool bPreserveTraceData
)

 Reset hit result while optionally saving TraceStart and TraceEnd.
Public function Const FString  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.