UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
FAINamedID< TCounter > Struct Template Reference

#include <AITypes.h>

Public Member Functions

 FAINamedID (const FName &InName)
 
 FAINamedID (const FAINamedID &Other)
 
FAINamedID & operator= (const FAINamedID &Other)
 
 FAINamedID ()
 
 operator typename TCounter::Type () const
 
bool IsValid () const
 

Static Public Member Functions

static uint32 GetSize ()
 
static FAINamedID< TCounter > InvalidID ()
 

Public Attributes

const TCounter::Type Index
 
const FName Name
 

Protected Member Functions

 FAINamedID (const FName &InName, typename TCounter::Type InIndex)
 

Static Protected Member Functions

static TCounter & GetCounter ()
 

Friends

uint32 GetTypeHash (const FAINamedID &ID)
 

Detailed Description

template<typename TCounter>
struct FAINamedID< TCounter >

TCounter needs to supply following functions: default constructor typedef X Type; where X is an integer type to be used as ID's internal type TCounter::Type GetNextAvailableID() - returns next available ID and advances the internal counter uint32 GetSize() const - returns number of unique IDs created so far OnIndexForced(TCounter::Type Index) - called when given Index has been force-used. Counter may need to update "next available ID"

Constructor & Destructor Documentation

◆ FAINamedID() [1/4]

template<typename TCounter >
FAINamedID< TCounter >::FAINamedID ( const FName &  InName,
typename TCounter::Type  InIndex 
)
inlineprotected

◆ FAINamedID() [2/4]

template<typename TCounter >
FAINamedID< TCounter >::FAINamedID ( const FName &  InName)
inline

◆ FAINamedID() [3/4]

template<typename TCounter >
FAINamedID< TCounter >::FAINamedID ( const FAINamedID< TCounter > &  Other)
inline

◆ FAINamedID() [4/4]

template<typename TCounter >
FAINamedID< TCounter >::FAINamedID ( )
inline

Member Function Documentation

◆ GetCounter()

template<typename TCounter >
static TCounter & FAINamedID< TCounter >::GetCounter ( )
inlinestaticprotected

◆ GetSize()

template<typename TCounter >
static uint32 FAINamedID< TCounter >::GetSize ( )
inlinestatic

◆ InvalidID()

template<typename TCounter >
static FAINamedID< TCounter > FAINamedID< TCounter >::InvalidID ( )
inlinestatic

◆ IsValid()

template<typename TCounter >
bool FAINamedID< TCounter >::IsValid ( ) const
inline

◆ operator typename TCounter::Type()

template<typename TCounter >
FAINamedID< TCounter >::operator typename TCounter::Type ( ) const
inline

◆ operator=()

template<typename TCounter >
FAINamedID & FAINamedID< TCounter >::operator= ( const FAINamedID< TCounter > &  Other)
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

template<typename TCounter >
uint32 GetTypeHash ( const FAINamedID< TCounter > &  ID)
friend

Member Data Documentation

◆ Index

template<typename TCounter >
const TCounter::Type FAINamedID< TCounter >::Index

◆ Name

template<typename TCounter >
const FName FAINamedID< TCounter >::Name
The documentation for this struct was generated from the following file: