loc kit

25 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.

loc.add_culture (risk 4, mutates, smoke)

No description.

Argument	Type	Description
culture	string	required. ICU culture name such as fr, ja, pt-BR.

Returns: target, warnings.

loc.audit_string_table (risk 0, smoke)

No description.

Argument	Type	Description
asset	string	required. StringTable asset reference.
limit	integer	Return at most this many duplicate/blank findings. Default 100.

Returns: table, warnings.

loc.audit_string_tables (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Content root to scan. Default TEXT("/Game").
recursive	boolean	Include StringTables below Folder. Default true.
limit	integer	Maximum returned assets. Default 200.

loc.compile_status (risk 0, smoke)

No description.

Argument	Type	Description
target	string	required. Localization target name.

Returns: target, root, manifestExists, archiveExists, locresCultures, missingCultures, notes.

loc.create_string_table (risk 2, mutates, smoke)

Creates a StringTable asset with an optional namespace and initial key -> source entries; returns the entries.

Argument	Type	Description
folder	string	required. Content folder, e.g. /Game/Localization.
name	string	required. Asset name, e.g. ST_UI.
namespace	string	Text namespace of the table; empty keeps the engine default (the table id).
entries	array of UeaKeyValue	Initial entries: key -> source string.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.create_target (risk 4, mutates, smoke)

No description.

Argument	Type	Description
target	string	required. New localization target name.
nativeCulture	string	required. Native culture such as en, en-US, pt-BR.
persist	boolean	Save the localization settings config after the edit; false keeps the change in memory only (undoable, lost on restart). Default true.

Returns: target, warnings.

loc.duplicate_string_table (risk 2, mutates, smoke)

Duplicates a StringTable asset (new table id = new asset path); returns the copy's entries.

Argument	Type	Description
asset	string	required. Source StringTable asset reference.
newName	string	required. New asset name.
folder	string	Destination folder; empty uses the source folder.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.gather_status (risk 0, smoke)

No description.

Argument	Type	Description
target	string	required. Localization target name.

Returns: target, root, manifestExists, archiveExists, locresCultures, missingCultures, notes.

loc.get_target (risk 0, smoke)

No description.

Argument	Type	Description
target	string	required. Localization target name.

Returns: target, warnings.

loc.list_string_tables (risk 0, smoke)

No description.

Argument	Type	Description
folder	string	Content root to scan. Default TEXT("/Game").
recursive	boolean	Include StringTables below Folder. Default true.
limit	integer	Maximum returned assets. Default 200.

loc.list_targets (risk 0, smoke)

No description.

Argument	Type	Description
scope	string	"game" (default) edits the project target set; "engine" is read-only. Default TEXT("game").

Returns: targets, count.

loc.remove_culture (risk 4, mutates, destructive, smoke)

No description.

Argument	Type	Description
culture	string	required. ICU culture name such as fr, ja, pt-BR.

Returns: target, warnings.

loc.remove_target (risk 4, mutates, destructive, smoke)

No description.

Argument	Type	Description
persist	boolean	Save the localization settings config after the edit; false keeps the change in memory only (undoable, lost on restart). Default true.

Returns: target, warnings.

loc.set_native_culture (risk 4, mutates, smoke)

No description.

Argument	Type	Description
culture	string	required. ICU culture name such as fr, ja, pt-BR.

Returns: target, warnings.

loc.string_table_clear_entries (risk 5, mutates, destructive, smoke)

No description.

Argument	Type	Description
asset	string	required. StringTable asset reference.
limit	integer	Return at most this many duplicate/blank findings. Default 100.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_find_entries (risk 0, smoke)

No description.

Argument	Type	Description
contains	string	Case-insensitive text searched in keys (and source strings unless keysOnly).
keysOnly	boolean	Search keys only. Default false.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_get_entry (risk 0, smoke)

No description.

Argument	Type	Description
key	string	required. Entry key.
value	string	Source string (set tools only).

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_list_entries (risk 0, smoke)

No description.

Argument	Type	Description
asset	string	required. StringTable asset reference.
limit	integer	Return at most this many duplicate/blank findings. Default 100.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_merge (risk 2, mutates, smoke)

No description.

Argument	Type	Description
target	string	required. StringTable receiving the entries.
source	string	required. StringTable providing the entries (must differ from target).
overwrite	boolean	Replace keys that already exist in target. Default false.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_remove_entry (risk 3, mutates, destructive, smoke)

No description.

Argument	Type	Description
key	string	required. Entry key.
value	string	Source string (set tools only).

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_rename_key (risk 2, mutates, smoke)

No description.

Argument	Type	Description
key	string	required. Existing key.
newKey	string	required. New key.
overwrite	boolean	Replace newKey when it already exists. Default false.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_set_entries (risk 2, mutates, smoke)

No description.

Argument	Type	Description
entries	array of UeaKeyValue	required. Entries to set: key -> source string.

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.string_table_set_entry (risk 2, mutates, smoke)

No description.

Argument	Type	Description
key	string	required. Entry key.
value	string	Source string (set tools only).

Returns: asset, entries, count, tables, count, totalEntries, totalBlankSources.

loc.validate_target (risk 0, smoke)

No description.

Argument	Type	Description
target	string	required. Localization target name.

Returns: target, warnings.

loc.validate_targets (risk 0, smoke)

No description.

Argument	Type	Description
targets	array of string	Target names. Empty validates every target in scope.

Returns: results, validCount, invalidCount.