1. Epic GamesDeveloper
  3. UNamingTokensEngineSubsystem

UNamingTokensEngineSubsystem

An editor subsystem for registering global tokens and evaluating strings across the entire project.

API > API/Plugins > API/Plugins/NamingTokens

An editor subsystem for registering global tokens and evaluating strings across the entire project.

   
Name UNamingTokensEngineSubsystem
Type class
Header File /Engine/Plugins/Developer/NamingTokens/Source/NamingTokens/Public/NamingTokensEngineSubsystem.h
Include Path #include "NamingTokensEngineSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UNamingTokensEngineSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNamingTokensEngineSubsystem()

   NamingTokensEngineSubsystem.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsCacheEnabled bool If the cache is currently enabled. NamingTokensEngineSubsystem.h  
CachedNamingTokens TMap< FString, TObjectPtr< UNamingTokens > > Naming tokens currently loaded from assets. NamingTokensEngineSubsystem.h
  • Transient
CachedNamingTokensMutex FCriticalSection   NamingTokensEngineSubsystem.h
  • Transient
FilterNamespaceDelegates TMap< FName, FFilterNamespace > Filters that will execute just before evaluating a token string NamingTokensEngineSubsystem.h  
GlobalNamespaces TSet< FString > Namespaces considered global (don't need to include namespace to access). NamingTokensEngineSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Clears all currently cached naming tokens. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

FNamingTokenResultData EvaluateTokenString ( const FString& InTokenString,
const FNamingTokenFilterArgs& InFilter,
const TArray< UObject* >& InContexts
)

 Parse and evaluate token string. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"
  • Meta=(AutoCreateRefTerm="InFilter,InContexts")

FNamingTokenResultData EvaluateTokenString ( const FString& InTokenString,
const FNamingTokenFilterArgs& InFilter
)

   NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"
  • Meta=(AutoCreateRefTerm="InFilter,InContexts")

FNamingTokenResultData EvaluateTokenText ( const FText& InTokenText,
const FNamingTokenFilterArgs& InFilter
)

   NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"
  • Meta=(AutoCreateRefTerm="InFilter,InContexts")

FNamingTokenResultData EvaluateTokenText ( const FText& InTokenText,
const FNamingTokenFilterArgs& InFilter,
const TArray< UObject* >& InContexts
)

 Parse and evaluate token text. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"
  • Meta=(AutoCreateRefTerm="InFilter,InContexts")

TArray< FString > GetAllNamespaces()

 Retrieve all discovered namespaces. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

FString GetFormattedTokensStringForDisplay ( const FNamingTokenFilterArgs& InFilter
) const

 Creates a friendly display string of all tokens. NamingTokensEngineSubsystem.h  

TArray< FString > GetGlobalNamespaces()

 Retrieve the registered global namespaces. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

TArray< UNamingTokens * > GetMultipleNamingTokens ( const TArray< FString >& InNamespaces
) const

 Lookup multiple naming tokens from multiple namespaces. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

TSet< FString > GetNamingTokenNamespacesFromString ( const FString& InTokenString,
const FNamingTokenFilterArgs& InFilter
) const

 Locate all reference naming token namespaces from a given string. NamingTokensEngineSubsystem.h  

UNamingTokens * GetNamingTokens ( const FString& InNamespace
) const

 Lookup naming tokens given a namespace. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

UNamingTokens * GetNamingTokensNative ( const FString& InNamespace
) const

 Lookup naming tokens given a namespace. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

bool IsCacheEnabled()

 If the cache is currently enabled. NamingTokensEngineSubsystem.h  

bool IsGlobalNamespaceRegistered ( const FString& InNamespace
) const

 Checks if a namespace is registered globally. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

void RegisterGlobalNamespace ( const FString& InNamespace
)

 Register tokens as a global namespace. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

void RegisterNamespaceFilter ( const FName OwnerName,
FFilterNamespace Delegate
)

 Register a delegate to filter the list of namespaces that can be used to evaluate tokens NamingTokensEngineSubsystem.h  

void SetCacheEnabled ( bool bEnabled
)

 Configure whether the cache is enabled or not. NamingTokensEngineSubsystem.h  

void UnregisterGlobalNamespace ( const FString& InNamespace
)

 Remove tokens from a global namespace. NamingTokensEngineSubsystem.h
  • BlueprintCallable
  • Category="NamingTokens"

void UnregisterNamespaceFilter ( const FName OwnerName
)

 Remove a delegate from the list of namespace filters NamingTokensEngineSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page