unreal.NamingTokens

class unreal.NamingTokens(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

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

C++ Source:

  • Plugin: NamingTokens

  • Module: NamingTokens

  • File: NamingTokens.h

Editor Properties: (see get_editor_property/set_editor_property)

  • current_evaluation_data (NamingTokensEvaluationData): [Read-Write] Cached shared data for this evaluation.

  • custom_tokens (Array[NamingTokenData]): [Read-Write] User defined tokens.

  • namespace (str): [Read-Write] The namespace to identify this token. note: Must contain alphanumeric and ‘_’ characters only and cannot be empty.

  • namespace_display_name (Text): [Read-Write] The full display name of the namespace to use in UI and filtering.

  • test_token_input (Text): [Read-Write] Enter a sample string using your tokens to output an evaluated result to TestTokenResult.

  • test_token_result (Text): [Read-Only] An evaluated text result of your token data.

property current_evaluation_data: NamingTokensEvaluationData

[Read-Only] Cached shared data for this evaluation.

Type:

(NamingTokensEvaluationData)

get_current_date_time() → DateTime

Retrieve the current datetime. By default, this uses shared data so results are consistent across runs.

Return type:

DateTime

on_post_evaluate() → None

Called after evaluation. Used so any cleanup can occur.

on_pre_evaluate(evaluation_data) → None

Called prior to evaluation. Allows consistent data to be set up for each token evaluation.

This is important if the data is temporally sensitive and could change between evaluating multiple tokens in a string, such as a high resolution timer.

Parameters:

evaluation_data (NamingTokensEvaluationData) – Contains generic shared data for this evaluation.