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

#include <BrainComponent.h>

Public Types

enum  EStatus { Failure , Success }
 

Public Member Functions

 FAIMessage ()
 
 FAIMessage (FName InMessage, UObject *InSender)
 
 FAIMessage (FName InMessage, UObject *InSender, FAIRequestID InID, EStatus InStatus)
 
 FAIMessage (FName InMessage, UObject *InSender, FAIRequestID InID, bool bSuccess)
 
 FAIMessage (FName InMessage, UObject *InSender, EStatus InStatus)
 
 FAIMessage (FName InMessage, UObject *InSender, bool bSuccess)
 
void SetFlags (uint8 Flags)
 
void SetFlag (uint8 Flag)
 
void ClearFlag (uint8 Flag)
 
bool HasFlag (uint8 Flag) const
 

Static Public Member Functions

static AIMODULE_API void Send (AController *Controller, const FAIMessage &Message)
 
static AIMODULE_API void Send (APawn *Pawn, const FAIMessage &Message)
 
static AIMODULE_API void Send (UBrainComponent *BrainComp, const FAIMessage &Message)
 
static AIMODULE_API void Broadcast (UObject *WorldContextObject, const FAIMessage &Message)
 

Public Attributes

FName MessageName
 
FWeakObjectPtr Sender
 
FAIRequestID RequestID
 
TEnumAsByte< EStatusStatus
 
uint8 MessageFlags
 

Member Enumeration Documentation

◆ EStatus

Enumerator
Failure 
Success 

Constructor & Destructor Documentation

◆ FAIMessage() [1/6]

FAIMessage::FAIMessage ( )
inline

◆ FAIMessage() [2/6]

FAIMessage::FAIMessage ( FName  InMessage,
UObject InSender 
)
inline

◆ FAIMessage() [3/6]

FAIMessage::FAIMessage ( FName  InMessage,
UObject InSender,
FAIRequestID  InID,
EStatus  InStatus 
)
inline

◆ FAIMessage() [4/6]

FAIMessage::FAIMessage ( FName  InMessage,
UObject InSender,
FAIRequestID  InID,
bool  bSuccess 
)
inline

◆ FAIMessage() [5/6]

FAIMessage::FAIMessage ( FName  InMessage,
UObject InSender,
EStatus  InStatus 
)
inline

◆ FAIMessage() [6/6]

FAIMessage::FAIMessage ( FName  InMessage,
UObject InSender,
bool  bSuccess 
)
inline

Member Function Documentation

◆ Broadcast()

void FAIMessage::Broadcast ( UObject WorldContextObject,
const FAIMessage Message 
)
static

◆ ClearFlag()

void FAIMessage::ClearFlag ( uint8  Flag)
inline

◆ HasFlag()

bool FAIMessage::HasFlag ( uint8  Flag) const
inline

◆ Send() [1/3]

void FAIMessage::Send ( AController Controller,
const FAIMessage Message 
)
static

◆ Send() [2/3]

void FAIMessage::Send ( APawn *  Pawn,
const FAIMessage Message 
)
static

◆ Send() [3/3]

void FAIMessage::Send ( UBrainComponent BrainComp,
const FAIMessage Message 
)
static

◆ SetFlag()

void FAIMessage::SetFlag ( uint8  Flag)
inline

◆ SetFlags()

void FAIMessage::SetFlags ( uint8  Flags)
inline

Member Data Documentation

◆ MessageFlags

uint8 FAIMessage::MessageFlags

message param: custom flags

◆ MessageName

FName FAIMessage::MessageName

type of message

◆ RequestID

FAIRequestID FAIMessage::RequestID

message param: ID

◆ Sender

FWeakObjectPtr FAIMessage::Sender

message source

◆ Status

TEnumAsByte<EStatus> FAIMessage::Status

message param: status


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