1. Epic GamesDeveloper
  3. UNamingTokens

UNamingTokens

Subclass to define naming tokens to use for a specific tool or project.

API > API/Plugins > API/Plugins/NamingTokens

Subclass to define naming tokens to use for a specific tool or project.

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

Syntax

UCLASS (MinimalAPI, Blueprintable, Abstract)  
class UNamingTokens : public UObject

Inheritance Hierarchy

Derived Classes

UNamingTokens derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNamingTokens()

   NamingTokens.h  

Typedefs

Name Type Remarks Include Path
FOnPostEvaluate TMulticastDelegate_OneParam< void, const FNamingTokenResultData &InResultData > Delegate when post evaluate is called. NamingTokens.h
FOnPreEvaluate TMulticastDelegate_OneParam< void, const FNamingTokensEvaluationData &InEvaluationData > Delegate when pre evaluate is called. NamingTokens.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultTokens TArray< FNamingTokenData > The default tokens defined by this class. NamingTokens.h  
ExternalTokens TMap< FGuid, TArray< FNamingTokenData > > External and temporary instance tokens which can be filled in by tools supporting unrecognized tokens. NamingTokens.h  
OnPostEvaluateEvent FOnPostEvaluate Delegate when post evaluate is called. NamingTokens.h  
OnPreEvaluateEvent FOnPreEvaluate Delegate when pre evaluate is called. NamingTokens.h  
TestTokenInput FText Enter a sample string using your tokens to output an evaluated result to TestTokenResult. NamingTokens.h
  • EditDefaultsOnly
  • Transient
  • Category="NamingTokens"
TestTokenResult FText An evaluated text result of your token data. NamingTokens.h
  • VisibleDefaultsOnly
  • Transient
  • Category="NamingTokens"

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AreExternalTokensRegistered ( const FGuid& InGuid
) const

 Check if external tokens are registered for a guid. NamingTokens.h  

void CreateDefaultTokens()

 Create any default tokens. NamingTokens.h  

void EvaluateTestToken()

 Evaluate the test token input. NamingTokens.h  

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

 Evaluate token text. Creates EvaluationData. NamingTokens.h  

FNamingTokenResultData EvaluateTokenText ( const FText& InTokenText,
const FNamingTokensEvaluationData& InEvaluationData
)

 Evaluate token text for a given EvaluationData. NamingTokens.h  

TArray< FNamingTokenData > GetAllTokens()

 Retrieve all tokens. NamingTokens.h  
Retrieve the current datetime. NamingTokens.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="NamingTokens"

const TArray< FNamingTokenData > & GetCustomTokens()

 Retrieve the custom tokens. NamingTokens.h  

const TArray< FNamingTokenData > & GetDefaultTokens()

 Retrieve the default tokens. NamingTokens.h  

TArray< FNamingTokenData > & GetExternalTokensChecked ( const FGuid& InGuid
)

 Retrieve the external tokens. Tokens must be registered and exist. NamingTokens.h  

FString GetFormattedTokensStringForDisplay()

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

const FString & GetNamespace()

 Retrieve the naming token's namespace. NamingTokens.h  

const FText & GetNamespaceDisplayName()

 Retrieve the namespace's friendly display name. NamingTokens.h  

FOnPostEvaluate & GetOnPostEvaluateEvent()

   NamingTokens.h  

FOnPreEvaluate & GetOnPreEvaluateEvent()

   NamingTokens.h  

virtual UWorld * GetWorld()

   NamingTokens.h  
Register an external token array which is managed from a caller. NamingTokens.h  

void UnregisterExternalTokens ( const FGuid& InGuid
)

 Unregister and clear out external tokens. NamingTokens.h  

void Validate()

 Validate internal values including namespace and token keys. NamingTokens.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NamingTokens.h  

virtual void PostInitProperties()

   NamingTokens.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual FDateTime GetCurrentDateTime_Implementation()

   NamingTokens.h  

virtual void OnCreateDefaultTokens ( TArray< FNamingTokenData >& Tokens
)

 Define any default tokens. NamingTokens.h  

void OnPostEvaluate()

 Called after evaluation. Used so any cleanup can occur. NamingTokens.h
  • BlueprintNativeEvent
  • Category="NamingTokens"

virtual void OnPostEvaluate_Implementation()

   NamingTokens.h
  • BlueprintNativeEvent
  • Category="NamingTokens"

void OnPreEvaluate ( const FNamingTokensEvaluationData& InEvaluationData
)

 Called prior to evaluation. NamingTokens.h
  • BlueprintNativeEvent
  • Category="NamingTokens"

virtual void OnPreEvaluate_Implementation ( const FNamingTokensEvaluationData& InEvaluationData
)

   NamingTokens.h
  • BlueprintNativeEvent
  • Category="NamingTokens"

void PostEvaluate ( const FNamingTokenResultData& InResultData
)

 Called after all tokens have evaluated. NamingTokens.h  

void PreEvaluate ( const FNamingTokensEvaluationData& InEvaluationData
)

 Called prior to token evaluation. NamingTokens.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetNamespacePropertyName()

 The name of the namespace property. NamingTokens.h  

static FName GetProcessTokenTemplateFunctionName()

   NamingTokens.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page