1. Epic GamesDeveloper
  3. FTypedElementCounter

FTypedElementCounter

Tracks various categories of counters for the typed elements (eg, the number of elements of a given type).

API > API/Runtime > API/Runtime/TypedElementFramework

Tracks various categories of counters for the typed elements (eg, the number of elements of a given type). The categories counted may be expanded by element types that implement the UTypedElementCounterInterface API.

   
Name FTypedElementCounter
Type class
Header File /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementCounter.h
Include Path #include "Elements/Framework/TypedElementCounter.h"

Syntax

class FTypedElementCounter

Constructors

Name Remarks Include Path Unreal Specifiers
  Elements/Framework/TypedElementCounter.h  
  Elements/Framework/TypedElementCounter.h  
  Elements/Framework/TypedElementCounter.h  
  Elements/Framework/TypedElementCounter.h  

Classes

Name Remarks
TCounterCategory  

Interfaces

Name Remarks
ICounterCategory  

Typedefs

Name Type Remarks Include Path
FCounterValue int32   Elements/Framework/TypedElementCounter.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CounterCategories TSortedMap< FName, TUniquePtr< ICounterCategory >, FDefaultAllocator, FNameFastLess > Counter categories. Elements/Framework/TypedElementCounter.h  
Registry TWeakObjectPtr< UTypedElementRegistry > Element registry this element counter is associated with. Elements/Framework/TypedElementCounter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddElement ( const FTypedElementHandle& InElementHandle
)

 Update the counter categories to include the given element. Elements/Framework/TypedElementCounter.h  

void ClearCounter ( const FName InCategory,
const KeyType& InKey
)

 Clear the value of the counter for the given category and key. Elements/Framework/TypedElementCounter.h  

void ClearCounters ()

 Clear all counters. Elements/Framework/TypedElementCounter.h  

void ClearCounters ( const FName InCategory
)

 Clear the value of the counters for the given category. Elements/Framework/TypedElementCounter.h  

void DecrementCounter ( const FName InCategory,
const KeyType& InKey
)

 Decrement the counter for the given category and key. Elements/Framework/TypedElementCounter.h  

void ForEachCounterValue ( const FName InCategory,
TFunctionRef< bool(const KeyType&, FCounterValue)> InCallback
) const

 Enumerate the value of the counters for the given category. Elements/Framework/TypedElementCounter.h  

FCounterValue GetCounterValue ( const FName InCategory,
const KeyType& InKey
) const

 Get the value of the counter for the given category and key, or zero if the category or key are unknown. Elements/Framework/TypedElementCounter.h  

void IncrementCounter ( const FName InCategory,
const KeyType& InKey
)

 Increment the counter for the given category and key. Elements/Framework/TypedElementCounter.h  

void Initialize ( UTypedElementRegistry* InRegistry
)

 Explicitly initialize this instance, if it was previously default constructed. Elements/Framework/TypedElementCounter.h  

void RemoveElement ( const FTypedElementHandle& InElementHandle
)

 Update the counter categories to remove the given element. Elements/Framework/TypedElementCounter.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetElementTypeCategoryName()

 Get the category name used to count element types (by type ID). Elements/Framework/TypedElementCounter.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Elements/Framework/TypedElementCounter.h  
  Elements/Framework/TypedElementCounter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page