UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AISense_Sight.cpp File Reference

Namespaces

namespace  UE
 
namespace  UE::AISense_Sight
 

Macros

#define AISENSE_SIGHT_TIMESLICING_DEBUG   0
 
#define DO_SIGHT_VLOGGING   (0 && ENABLE_VISUAL_LOG)
 
#define SIGHT_LOG_SEGMENT(...)
 
#define SIGHT_LOG_LOCATION(...)
 

Enumerations

enum class  EForEachResult : uint8 { Break , Continue }
 
enum  EReverseForEachResult : uint8 { UnTouched , Modified }
 

Functions

 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight"), STAT_AI_Sense_Sight, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Update Sort"), STAT_AI_Sense_Sight_UpdateSort, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Compute visibility"), STAT_AI_Sense_Sight_ComputeVisibility, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Query operations"), STAT_AI_Sense_Sight_QueryOperations, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Listener Update"), STAT_AI_Sense_Sight_ListenerUpdate, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Register Target"), STAT_AI_Sense_Sight_RegisterTarget, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Remove By Listener"), STAT_AI_Sense_Sight_RemoveByListener, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Remove To Target"), STAT_AI_Sense_Sight_RemoveToTarget, STATGROUP_AI)
 
 DECLARE_CYCLE_STAT (TEXT("Perception Sense: Sight, Process pending result"), STAT_AI_Sense_Sight_ProcessPendingQuery, STATGROUP_AI)
 
template<typename T , class PREDICATE_CLASS >
EForEachResult ForEach (T &Array, const PREDICATE_CLASS &Predicate)
 
template<typename T , class PREDICATE_CLASS >
EReverseForEachResult ReverseForEach (T &Array, const PREDICATE_CLASS &Predicate)
 
bool UE::AISense_Sight::IsTraceConsideredVisible (const FHitResult *HitResult, const AActor *TargetActor)
 

Variables

constexpr int32 DefaultMaxTracesPerTick = 6
 
constexpr int32 DefaultMaxAsyncTracesPerTick = 10
 
constexpr int32 DefaultMinQueriesPerTimeSliceCheck = 40
 
constexpr float DefaultPendingQueriesBudgetReductionRatio = 0.5f
 
constexpr bool bDefaultUseAsynchronousTraceForDefaultSightQueries = false
 
constexpr float DefaultStimulusStrength = 1.f
 

Macro Definition Documentation

◆ AISENSE_SIGHT_TIMESLICING_DEBUG

#define AISENSE_SIGHT_TIMESLICING_DEBUG   0

◆ DO_SIGHT_VLOGGING

#define DO_SIGHT_VLOGGING   (0 && ENABLE_VISUAL_LOG)

◆ SIGHT_LOG_LOCATION

#define SIGHT_LOG_LOCATION (   ...)

◆ SIGHT_LOG_SEGMENT

#define SIGHT_LOG_SEGMENT (   ...)

Enumeration Type Documentation

◆ EForEachResult

enum class EForEachResult : uint8
strong
Enumerator
Break 
Continue 

◆ EReverseForEachResult

Enumerator
UnTouched 
Modified 

Function Documentation

◆ DECLARE_CYCLE_STAT() [1/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight" ,
STAT_AI_Sense_Sight  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [2/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Compute visibility" ,
STAT_AI_Sense_Sight_ComputeVisibility  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [3/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Listener Update" ,
STAT_AI_Sense_Sight_ListenerUpdate  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [4/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Process pending result" ,
STAT_AI_Sense_Sight_ProcessPendingQuery  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [5/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Query operations" ,
STAT_AI_Sense_Sight_QueryOperations  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [6/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Register Target" ,
STAT_AI_Sense_Sight_RegisterTarget  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [7/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Remove By Listener" ,
STAT_AI_Sense_Sight_RemoveByListener  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [8/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Remove To Target" ,
STAT_AI_Sense_Sight_RemoveToTarget  ,
STATGROUP_AI   
)

◆ DECLARE_CYCLE_STAT() [9/9]

DECLARE_CYCLE_STAT ( TEXT("Perception Sense: Sight, Update Sort" ,
STAT_AI_Sense_Sight_UpdateSort  ,
STATGROUP_AI   
)

◆ ForEach()

template<typename T , class PREDICATE_CLASS >
EForEachResult ForEach ( T &  Array,
const PREDICATE_CLASS Predicate 
)

◆ ReverseForEach()

template<typename T , class PREDICATE_CLASS >
EReverseForEachResult ReverseForEach ( T &  Array,
const PREDICATE_CLASS Predicate 
)

Variable Documentation

◆ bDefaultUseAsynchronousTraceForDefaultSightQueries

constexpr bool bDefaultUseAsynchronousTraceForDefaultSightQueries = false
constexpr

◆ DefaultMaxAsyncTracesPerTick

constexpr int32 DefaultMaxAsyncTracesPerTick = 10
constexpr

◆ DefaultMaxTracesPerTick

constexpr int32 DefaultMaxTracesPerTick = 6
constexpr

◆ DefaultMinQueriesPerTimeSliceCheck

constexpr int32 DefaultMinQueriesPerTimeSliceCheck = 40
constexpr

◆ DefaultPendingQueriesBudgetReductionRatio

constexpr float DefaultPendingQueriesBudgetReductionRatio = 0.5f
constexpr

◆ DefaultStimulusStrength

constexpr float DefaultStimulusStrength = 1.f
constexpr