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

#include <AISense_Damage.h>

Public Types

typedef class UAISense_Damage FSenseClass
 

Public Member Functions

AIMODULE_API FAIDamageEvent ()
 
AIMODULE_API FAIDamageEvent (AActor *InDamagedActor, AActor *InInstigator, float DamageAmount, const FVector &EventLocation, const FVector &InHitLocation=FAISystem::InvalidLocation, FName InTag=NAME_None)
 
AIMODULE_API void Compile ()
 
bool IsValid () const
 
AIMODULE_API IAIPerceptionListenerInterfaceGetDamagedActorAsPerceptionListener () const
 

Public Attributes

float Amount
 
FVector Location
 
FVector HitLocation
 
TObjectPtr< AActorDamagedActor
 
TObjectPtr< AActorInstigator
 
FName Tag
 

Member Typedef Documentation

◆ FSenseClass

Constructor & Destructor Documentation

◆ FAIDamageEvent() [1/2]

FAIDamageEvent::FAIDamageEvent ( )

◆ FAIDamageEvent() [2/2]

FAIDamageEvent::FAIDamageEvent ( AActor InDamagedActor,
AActor InInstigator,
float  DamageAmount,
const FVector EventLocation,
const FVector InHitLocation = FAISystem::InvalidLocation,
FName  InTag = NAME_None 
)

Member Function Documentation

◆ Compile()

void FAIDamageEvent::Compile ( )

◆ GetDamagedActorAsPerceptionListener()

IAIPerceptionListenerInterface * FAIDamageEvent::GetDamagedActorAsPerceptionListener ( ) const

◆ IsValid()

bool FAIDamageEvent::IsValid ( ) const
inline

Member Data Documentation

◆ Amount

float FAIDamageEvent::Amount

Damage taken by DamagedActor. @Note 0-damage events do not get ignored

◆ DamagedActor

TObjectPtr<AActor> FAIDamageEvent::DamagedActor

Damaged actor

◆ HitLocation

FVector FAIDamageEvent::HitLocation

Event's additional spatial information @TODO document

◆ Instigator

TObjectPtr<AActor> FAIDamageEvent::Instigator

Actor that instigated damage. Can be None

◆ Location

FVector FAIDamageEvent::Location

Event's "Location", or what will be later treated as the perceived location for this sense. If not set, HitLocation will be used, if that is unset too DamagedActor's location

◆ Tag

FName FAIDamageEvent::Tag

Optional named identifier for the damage.


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