tags kit

10 tools. Generated from the plugin source; do not edit by hand.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

tags.compare_containers (risk 0, smoke)

Compares two tag containers using native hierarchical or exact matching semantics.

Argument	Type	Description
actual	array of string	First explicit Gameplay Tag set.
expected	array of string	Second explicit Gameplay Tag set.
exact	boolean	Match only identical tag names instead of allowing hierarchical parent matches. Default false.

Returns: matchesAny, matchesAll, matchesNone, matching, unmatchedActual, unmatchedExpected, message.

tags.evaluate_requirements (risk 0, smoke)

Evaluates allOf, anyOf, and noneOf as one Gameplay Tag requirement set.

Argument	Type	Description
tags	array of string	Explicit Gameplay Tag set to evaluate.
allOf	array of string	Every tag that must match.
anyOf	array of string	At least one tag that must match; empty imposes no requirement.
noneOf	array of string	No tag in this set may match.

Returns: matches, description, missingAllOf, matchingAnyOf, matchingNoneOf, message.

tags.filter_container (risk 0, smoke)

Returns the entries of Tags selected by Filter using native hierarchical or exact semantics.

Argument	Type	Description
tags	array of string	Explicit Gameplay Tag set to filter.
filter	array of string	Tags that select the matching entries.
exact	boolean	Match only identical tag names instead of allowing hierarchical parent matches. Default false.

Returns: tags, count, message.

tags.find_registered (risk 0, smoke)

Finds registered tag names by bounded case-insensitive text search.

Argument	Type	Description
contains	string	Case-insensitive name fragment; empty returns the dictionary from the start.
parent	string	Optional registered parent tag whose descendants are returned.
limit	integer	Maximum returned names, from 1 through 5000. Default 500.

Returns: tags, total, truncated.

tags.get_info (risk 0, smoke)

Reports the Gameplay Tags module and the ownership boundary with bp.* and gas.*.

Argument	Type	Description
tags	array of string	Registered Gameplay Tag names. Duplicate values are collapsed.

Returns: gameplayTagsAvailable, capabilities, boundaries, message.

tags.get_parents (risk 0, smoke)

Returns a registered tag and all of its registered parents.

Argument	Type	Description
tag	string	required. Registered Gameplay Tag name.

Returns: tag, tagAndParents, parents, depth, message.

tags.list_children (risk 0, smoke)

Returns registered descendants of one tag using the Gameplay Tags manager hierarchy.

Argument	Type	Description
tag	string	required. Registered Gameplay Tag name.

Returns: tag, tagAndParents, parents, depth, message.

tags.list_registered (risk 0, smoke)

Lists registered gameplay tags, optionally narrowed by a hierarchical prefix, without editing tag sources.

Argument	Type	Description
contains	string	Case-insensitive name fragment; empty returns the dictionary from the start.
parent	string	Optional registered parent tag whose descendants are returned.
limit	integer	Maximum returned names, from 1 through 5000. Default 500.

Returns: tags, total, truncated.

tags.normalize_container (risk 0, smoke)

Normalizes an explicit set of registered Gameplay Tag names without changing project definitions.

Argument	Type	Description
tags	array of string	Registered Gameplay Tag names. Duplicate values are collapsed.

Returns: tags, count, message.

tags.validate_registered (risk 0, smoke)

Validates explicit tag text against the currently registered dictionary and returns normalized registered names.

Argument	Type	Description
tags	array of string	Registered Gameplay Tag names. Duplicate values are collapsed.

Returns: validTags, invalidTags, valid.