Kit asset
231 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.
As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em
tools/list).
Guia
Content-browser assets: find/query the registry, lifecycle (create, duplicate, rename, move,
delete, save, single + bulk), dependencies and redirectors, validation, metadata, folders,
thumbnails, source control, content browser control, factories for the common simple asset types,
collections, package and disk facts, bulk organisation, structured content (data tables, curves,
string tables, data assets) and advanced file import/export. The kit spans seven classes
(UUeaKit_Asset, UUeaKit_AssetCollections, UUeaKit_AssetRegistry, UUeaKit_AssetPackages,
UUeaKit_AssetSourceControl, UUeaKit_AssetData, UUeaKit_AssetImport), all registering as kit
asset, over two prefixes.
| Prefix | Tools | What it covers |
|---|---|---|
asset. | 191 | registry queries and graphs, lifecycle (single + bulk), collections, packages/disk/dirty state, path and name helpers, bulk organisation, source control, validation, metadata, folders, thumbnails, content browser, factories, data tables, curves, string tables, data assets |
import. | 24 | typed importers (texture, static/skeletal mesh, animation, sound, glTF), configured and batched imports, factory option discovery, reimport management, exporters |
215 tools in total (214 on UE 4.27: import.interchange_info needs 5.1+). Every tool takes JSON arguments named after the C++ struct fields in
camelCase without the b prefix (bRecursive -> recursive). Asset references accept an object
path (/Game/Folder/Asset.Asset), a package path (/Game/Folder/Asset) or a unique bare name.
Start here
asset.find {name, folder, class, recursive, limit}andasset.get_summary {asset}are core tools: always listed, regardless of exposure mode or kit activation.edit.search_tools {query:"import mesh"}finds tools by words in name + description;edit.get_tool_schema {tool:"asset.rename_many"}gives the full input/output JSON schema.edit.enable_kits {kits:["asset"]}advertises everyasset.*/import.*tool in Adaptive mode (they stay callable either way).
Tools
asset. (registry, lifecycle, dependencies, factories)
| Tool | Purpose |
|---|---|
asset.find {name, folder, class, recursive, limit} / asset.list_folder {folder} / asset.exists / asset.exists_many {assets} | Search by name substring + folder + class; folder listing; existence checks (registry only, nothing loaded). |
asset.get_summary / asset.get_registry_tags / asset.get_file_info / asset.get_state_many | Class, parent, dirty state, dependencies, referencers, first 60 properties; registry tags (ParentClass, RowStructure...); file size/timestamp/cooked; bulk loaded/dirty/size. |
asset.list_classes {folder} / asset.count {folder, class} / asset.find_by_class {class, includeDerived, onDiskOnly} / asset.find_by_tag {tag, value, contains} / asset.find_blueprints_by_parent {parentClass, includeSubclasses} | Registry queries. |
asset.get_size_report {folder, class, limit} / asset.list_recent / asset.find_unused {class, folder} | Largest assets + totals per class; most recently modified files; assets nothing references. |
asset.get_dependencies / asset.get_referencers (hard, soft, recursive, maxDepth, includeScript) / asset.find_circular_dependencies | Dependency graph walks (each entry carries depth and via); A -> B -> A cycles. |
asset.list_redirectors {folder} / asset.fix_redirectors {folder, recursive, dryRun, save} | Redirectors left by renames/moves; fix_redirectors loads the referencing packages, repoints them at the real assets and deletes the redirectors. It never prompts (the engine's own FixupReferencers ends in a modal report window and is not used). Run with dryRun:true to list the redirectors and their referencers first; pass save:true to write the updated referencers to disk. |
asset.validate {assets} | Data validation (IsDataValid + registered validators). |
asset.create_folder {folder} / asset.duplicate {asset, folder, newName} / asset.rename / asset.move {asset, folder} | Single-asset lifecycle (rename/move fix up referencers). |
asset.duplicate_many {assets, folder} / asset.move_many / asset.rename_many {folder, find, replace, prefix, suffix, class, dryRun} / asset.delete_many {assets, force} | Bulk versions; per-asset failures are reported instead of stopping. rename_many with dryRun:true previews. |
asset.delete / asset.consolidate {target, assets} | Delete one asset (refuses while referenced); merge duplicates into target and delete them. |
asset.save / asset.save_many {assets} / asset.save_all | Write packages to disk. Nothing is auto-saved. |
asset.create_folders {folders} / asset.rename_folder {folder, newFolder} / asset.duplicate_folder / asset.delete_folder / asset.folder_has_assets | Content folders. |
asset.get_metadata / asset.set_metadata {asset, key, value} / asset.remove_metadata | Editor metadata tags (UMetaData). |
asset.set_texture_settings {asset, srgb, compression, lodGroup, mipGen, maxSize, neverStream, save} | Post-import texture settings (-1 / empty / 0 keep). |
asset.render_thumbnail {asset, size, savePath} | Thumbnail as a PNG image block (32-1024 px). |
asset.get_source_control_state {assets} / asset.checkout / asset.revert | Source control on assets. |
asset.open_editor / asset.get_open_editors / asset.close_editor / asset.close_all_editors | Asset editor windows. |
asset.sync_browser {assets} / asset.set_browser_folder {folder} / asset.get_browser_folder / asset.get_browser_selection | Content Browser navigation and selection. |
asset.create {class, folder, name, factory, factoryProperties, save} / asset.list_factories {contains} | Any class with a "new asset" factory; the factory list with supported class and import extensions. |
asset.create_material / create_material_instance {source:parent} / create_material_function / create_data_table {source:rowStruct} / create_curve {type:float|vector|linearcolor} / create_enum {values} / create_struct {fields:[{name, type, default}]} / create_data_asset {source:class} / create_level {source:template} / create_render_target {width, height} / create_font / create_sound_cue {source:wave} / create_sound_class / create_sound_mix / create_physical_material {source:subclass} / create_physics_asset {source:skeletalMesh} / create_string_table / create_object_library | Typed factories; all take folder, name, save. Struct field types use the bp type syntax (float, object:Actor, struct:HitResult, append [] for arrays). |
asset.data_table_fill {asset, text|file, format} / asset.data_table_export {asset, format, savePath} | DataTable rows from/to CSV or JSON (fill replaces existing rows). |
asset.string_table_list / asset.string_table_set {asset, entries:[{key, value}]} | StringTable entries. |
asset.import_file {file, folder, name} | Automatic importer, no dialogs (FBX, PNG, WAV, ...); simple single-asset variant of import.files. |
import. (files in and out)
| Tool | Purpose |
|---|---|
import.files {files, folder} | Automatic importer, no dialogs, many files at once. |
import.texture {file, folder, srgb, compression, lodGroup, mipGen} | Texture with settings applied at import. |
import.static_mesh {file, folder, importScale, combineMeshes, generateCollision, generateLightmapUVs, importMaterials, importTextures} | FBX/OBJ static mesh. |
import.skeletal_mesh {file, folder, skeleton, createPhysicsAsset, importMorphTargets, importAnimations} | FBX skeletal mesh (reuses skeleton or creates one). |
import.animation {file, folder, skeleton} / import.sound {file, folder} | Animation sequence onto a skeleton; WAV/OGG/FLAC. |
import.reimport {asset, file} / import.export {asset, file} / import.list_formats | Reimport from the recorded (or a new) source; export by extension (fbx, obj, png, tga, wav, csv, json, t3d, copy); supported extensions per factory. |
asset. (collections)
| Tool | Purpose |
|---|---|
asset.list_collections {contains, shareType, includeCounts} / asset.get_asset_collections {asset, recursive} | Collections with share type, storage mode, parent, colour and asset count; which collections hold an asset. |
asset.create_collection {name, shareType, storageMode, parent, query} / asset.delete_collection {collection, recursive} / asset.rename_collection {collection, newName, newShareType} / asset.reparent_collection {collection, parent} | Lifecycle and nesting. Names are sanitised (letters, digits, _, -); shareType is local (default), private or shared; storageMode is static or dynamic (a saved content-browser query). |
asset.add_to_collection {collection, assets} / asset.remove_from_collection / asset.get_collection_assets {collection, recursive, limit} / asset.empty_collection | Static collection contents. |
asset.collection_from_search {name, folder, classFilter, nameContains, limit} | Creates (or refills) a collection from a registry search in one call. |
asset.set_collection_color {collection, r, g, b, a, clear} | Content browser colour. |
asset. (registry queries, graphs and folder audits)
| Tool | Purpose |
|---|---|
asset.query {packagePaths, classes, recursiveClasses, recursivePaths, tags:[{key,value}], packageNames, onDiskOnly, includeTags, limit, offset} | The full FARFilter in one call, with paging. Start here for anything the narrow finders cannot express. |
asset.get_by_package {package, includeTags} / asset.list_by_tag_value {tag, value, folder} / asset.list_tags_of_class {class, folder, sampleSize} | Objects inside one package; exact tag/value matches; the distinct tag keys a class carries, with an example value each. |
asset.get_derived_classes {class, recursive, limit} / asset.get_class_ancestors {class} | Class hierarchy from the registry (native classes and Blueprint generated classes). |
asset.list_paths {base, recursive} / asset.path_exists {path} / asset.scan_paths {paths, force} / asset.scan_files {paths, force} | Content folders known to the registry; force a synchronous rescan after writing files outside the editor. |
asset.registry_status / asset.wait_for_registry {timeoutSeconds} | Whether the initial scan finished; wait_for_registry lets editor frames pass until it does. |
asset.get_dependency_graph {asset, depth, hard, soft, searchable, manage, includeScript, limit} / asset.get_referencer_graph | Edge lists (from, to, category, hard, depth) up to depth 4, downward and upward. |
asset.find_orphans {folder} / asset.find_missing_references {folder} / asset.find_duplicates_by_name {folder} / asset.diff_folders {a, b} | Audits: nothing outside the folder references them; references to packages that no longer exist; same name in several folders; folder comparison by asset name. |
asset.get_asset_size_breakdown {folder, groupBy:"class" or "subfolder"} / asset.list_largest {folder, class, limit} | Disk size grouped or ranked. |
asset. (packages, paths and bulk organisation)
| Tool | Purpose |
|---|---|
asset.get_package_info {asset} / asset.list_loaded_packages {folder, dirtyOnly} / asset.fully_load {asset} | File on disk, size, load/dirty state, PKG flags, objects in the package. |
asset.list_dirty / asset.mark_dirty {assets} / asset.clear_dirty {assets} / asset.save_dirty {prompt, includeMaps, includeContent} | Unsaved-change handling. clear_dirty drops the flag without saving. |
asset.unload_packages {packages, includeDirty} / asset.reload_packages | Free memory / discard in-memory changes. |
asset.sanitize_name {name} / asset.make_unique_name {folder, base, suffix} / asset.validate_path {path} / asset.split_path {path} | Name and path helpers; split_path returns package, asset, sub-object, mount point, folder and the file on disk. |
asset.list_mount_points / asset.list_content_plugins | Content roots (/Game/, /Engine/, plugin mounts) and enabled plugins with content. |
asset.organize_by_class {folder, mapping:[{class, subfolder}], dryRun} / asset.apply_naming_prefix {folder, mapping:[{class, prefix}], dryRun} / asset.find_naming_violations {folder, mapping} | Bulk organisation. Defaults: Blueprints/Materials/Textures/Meshes/Sounds and BP_, M_, MI_, MF_, T_, SM_, SK_, S_. |
asset.move_folder {folder, newParent} / asset.list_empty_folders {folder} / asset.delete_empty_folders {folder, dryRun} / asset.copy_folder_to_plugin {folder, plugin, subfolder} | Folder moves and cleanup; the plugin copy is an advanced copy (dependencies follow). |
asset. (source control per asset)
| Tool | Purpose |
|---|---|
asset.sc_get_provider / asset.sc_status {assets, updateStatus} | Provider name/enabled/available; per-asset checked out (and by whom), modified, added, deleted, current, conflicted, revision. |
asset.sc_checkout_many {assets} / asset.sc_add_many / asset.sc_revert_many {assets, unchangedOnly} / asset.sc_checkin {assets, description, keepCheckedOut} | The everyday operations. |
asset.sc_sync {assets or folder} / asset.sc_history {asset, limit} / asset.sc_diff_against_depot {asset} / asset.sc_list_changed {folder} | Sync to head; revision list; fetch the head revision and report whether the local file differs; locally changed files under a folder. |
asset.sc_lock {assets} / asset.sc_unlock | Locking, where the provider supports it. The engine provider interface has no separate lock operation, so lock is a check out and unlock a revert of an unmodified check out (the reply's hint says so). |
Every source control tool answers E_NOT_SUPPORTED with a clear message when no provider is enabled.
asset. (data tables, curves, string tables, data assets)
| Tool | Purpose |
|---|---|
asset.data_table_info {asset} / asset.data_table_set_row_struct {asset, rowStruct} | Row struct, typed columns, row count, composite parents. Changing the row struct drops every row. |
asset.data_table_list_rows {asset, nameContains, includeValues, limit, offset} / asset.data_table_get_row {asset, row} / asset.data_table_find_rows {asset, column, value, contains} | Reading rows. Columns are addressed by their authored name (what the editor shows). |
asset.data_table_add_row {asset, row, values:[{key,value}]} / asset.data_table_set_cell {asset, row, column, value} / asset.data_table_set_row / asset.data_table_duplicate_row {row, newName} / asset.data_table_rename_row / asset.data_table_reorder_row {row, direction, steps} / asset.data_table_remove_row / asset.data_table_clear | Row CRUD. Values are the same text the details panel accepts; unknown columns come back in problems instead of failing the call. |
asset.data_table_import_csv {asset, csv or file} / asset.data_table_import_json {asset, json or file} / asset.data_table_export_json {asset} | Whole-table import (replaces the rows) and JSON export. asset.data_table_export (CSV or JSON) still exists on the original class. |
asset.composite_table_set_parents {asset, parents} | Parent tables of a CompositeDataTable, lowest priority first. |
asset.curve_info {asset, channel} / asset.curve_get_keys / asset.curve_evaluate {asset, time, channel} | Curve channels: value (CurveFloat), x/y/z (CurveVector), r/g/b/a (CurveLinearColor). Empty channel means every channel. |
asset.curve_add_key {asset, time, value, interp} / asset.curve_set_keys {asset, channel, keys} / asset.curve_remove_key {asset, index or time} / asset.curve_clear / asset.curve_set_interpolation {asset, interp} | Key editing. interp is linear, constant, cubic or none. |
asset.string_table_find {asset, contains, keysOnly} / asset.string_table_import_csv {asset, csv or file, replace} / asset.string_table_export_csv {asset, savePath} / asset.string_table_remove {asset, key} | StringTable search, CSV round trip (header Key,SourceString) and entry removal. |
asset.data_asset_get {asset} / asset.data_asset_set {asset, values:[{key,value}], save} / asset.list_data_assets {class, folder} | Editable properties of any DataAsset as text. |
asset.list_primary_assets {type, limit} / asset.get_primary_asset_id {asset} / asset.asset_manager_scan {paths, type, baseClass, hasBlueprintClasses, editorOnly} | Asset manager: registered types, the id of an asset, and registering a folder as a primary asset type. |
import. (advanced import and export)
| Tool | Purpose |
|---|---|
import.get_options {format, includeOptionsObject} / import.list_importable_extensions / import.list_exporters {class} | Discovery. get_options returns the factory's editable properties with their defaults and the keys to pass to import.with_options (including nested ones such as ImportUI.bImportMaterials). |
import.with_options {file, folder, name, factory, options:[{key,value}], replaceExisting, save} / import.batch {tasks, save} | Configured imports through UAssetImportTask; batch runs every task in one ImportAssetTasks call and reports per task. |
import.fbx_static_mesh / import.fbx_skeletal_mesh / import.fbx_animation | Typed FBX imports with named arguments instead of factory property paths (lightmap UVs, collision, combine, morph targets, physics asset, skeleton, frame range, scale, axis conversion). |
import.texture_with_settings {file, folder, compression, srgb, mipGen, lodGroup, maxSize, flipGreen} / import.audio {file, folder, compressionQuality, looping, soundGroup} | Typed texture and sound imports, settings applied right after the import. |
import.csv_to_data_table {file, rowStruct, folder, name} / import.json_to_data_table | Create a DataTable from a file on disk in one call. |
import.gltf {file, folder, name, options} | glTF/GLB through whichever glTF importer the engine has. |
import.can_reimport {asset} / import.get_source_files {asset} / import.set_source_file {asset, file, index} / import.reimport_many {assets, askForNewFiles} / import.reimport_folder {folder, classFilter, dryRun} | Reimport management; get_source_files also reports which recorded files are gone. |
import.export_many {assets, directory, extension} / import.export_to_fbx {asset, file, options} / import.export_texture {asset, file} / import.export_data_table_csv {asset, file} | Exporting. |
import.get_last_import_log / import.interchange_info (5.1+) | Warnings and errors captured during the last import/export call of this kit; whether Interchange is present and enabled. |
Recipe: import and wire a prop
edit.call_many {
"calls": [
{"tool": "asset.create_folder", "argsJson": "{\"folder\":\"/Game/Props\"}"},
{"tool": "import.static_mesh", "argsJson": "{\"file\":\"D:/Art/Crate.fbx\",\"folder\":\"/Game/Props\",\"name\":\"SM_Crate\"}"},
{"tool": "asset.create_material_instance", "argsJson": "{\"folder\":\"/Game/Props\",\"name\":\"MI_Crate\",\"source\":\"/Game/Materials/M_Base\"}"},
{"tool": "asset.save_many", "argsJson": "{\"assets\":[\"/Game/Props/SM_Crate\",\"/Game/Props/MI_Crate\"]}"}
],
"stopOnError": true
}
argsJson is a JSON object string; each result carries ok, resultJson and milliseconds.
Wrap the batch in edit.begin_transaction {title:"Import crate"} ... edit.end_transaction when
the user should be able to undo it in one step.
Recipe: asset dependency cleanup
asset.list_redirectors {folder:"/Game", recursive:true}->asset.fix_redirectors {folder:"/Game"}.asset.find_unused {class:"Object", folder:"/Game/Old"}(maps and assets referenced only by/Script/count as unused) andasset.get_size_report {folder:"/Game"}to pick targets.- Before deleting:
asset.get_referencers {asset:"T_Old", recursive:true, maxDepth:2}andasset.find_circular_dependencies {asset:"BP_Hub"}. asset.consolidate {target:"/Game/Textures/T_Rock", assets:["/Game/Old/T_Rock2", "/Game/Old/T_Rock_copy"]}redirects every reference and deletes the duplicates;asset.delete_many {assets:[...]}for the rest (force:truenulls out remaining references, so avoid it unless the referencers are being deleted too).asset.validate {assets:[...]}on the survivors, thenasset.save_all.
Recipe: organise a messy folder
asset.find_naming_violations {folder:"/Game/Imported"}andasset.organize_by_class {folder:"/Game/Imported", dryRun:true}- read the plannedchanges.- Adjust with an explicit
mappingwhen the defaults are wrong ([{"class":"Texture","subfolder":"Tex","prefix":"TX_"}]). - Run both for real:
asset.apply_naming_prefix {folder, dryRun:false}first, thenasset.organize_by_class {folder, dryRun:false}(rename before moving). asset.fix_redirectors {folder:"/Game", recursive:true}to clean up after the moves.asset.list_empty_folders {folder:"/Game/Imported"}->asset.delete_empty_folders {folder:"/Game/Imported", dryRun:false}.asset.save_dirty {prompt:false}(orasset.save_all).
Recipe: fill a data table
asset.create_data_table {folder, name, source:"MyRowStruct"}(orasset.data_table_set_row_structon an existing one - it drops every row).asset.data_table_info {asset}to read the column names to use (authored names).asset.data_table_add_row {asset, row:"Sword", values:[{"key":"Damage","value":"12"}]}per row, orimport.csv_to_data_table/asset.data_table_import_csvfor a whole file.asset.data_table_find_rows {asset, column:"Damage", value:"12"}to verify andasset.data_table_export_json {asset}to read it back.asset.save {asset}.
Recipe: collections as a working set
asset.collection_from_search {name:"ReviewMe", folder:"/Game/Characters", classFilter:"SkeletalMesh"}.asset.add_to_collection {collection:"ReviewMe", assets:[...]}for extras andasset.set_collection_color {collection:"ReviewMe", r:1, g:0.6, b:0.1}to make it visible.asset.get_collection_assets {collection:"ReviewMe"}feeds any bulk tool.asset.delete_collection {collection:"ReviewMe", recursive:true}when done (assets are untouched).
Recipe: import with exact factory options
import.get_options {format:"fbx"}- theoptionslist gives every key and its default, including nested ones such asImportUI.bImportMaterials.import.with_options {file, folder, name, options:[{"key":"ImportUI.bImportMaterials","value":"false"}]}, orimport.batch {tasks:[...]}for a whole directory in one call.import.get_last_import_logfor the warnings the importer produced.import.can_reimport {asset}/import.set_source_filewhen the source moved, thenimport.reimport_many {assets}(orimport.reimport_folder {folder, dryRun:true}first).
Gotchas
- Tools marked
Mutatesin the schema run inside an editor transaction and are undoable withedit.undo;edit.begin_transactiongroups several into one step. File imports on disk are not transactional (the source file itself is untouched, but the created asset is). - Destructive tools:
asset.delete,asset.delete_many(force:truenulls references),asset.delete_folder,asset.consolidate,asset.revert.asset.deleterefuses while referencers exist; checkasset.get_referencersfirst. asset.delete,asset.delete_manyandasset.delete_folderareNonUndoable(replyundoable:false): the packages are removed from disk, and when the undo history still references a deleted asset (for example through a deleted actor) the history is cleared, as the editor's own delete does. References held by deleted actors are cleared too, so the same path can be created again in the same session.edit.call_many {atomic:true}and atomicedit.run_workflowrefuse them up front; delete in a separate call (workflowcleanuplists run their steps directly). A checkpoint rollback after a delete reportsnon_undoable_call(andhistory_resetwhen the history was cleared) and never claimscomplete.- Nothing is auto-saved:
asset.save/asset.save_many/asset.save_all(orsave:trueon the create/import tools) write to disk.asset.save_allbeforeplay.startso PIE sees the latest compiled state. asset.rename_manyandasset.find_unusedcan touch hundreds of assets: usedryRun:trueand afolderfilter first. Bulk tools (*_many,asset.validate) report per-itemfailedentries instead of aborting.- Source control tools (
asset.checkout,asset.revert,asset.get_source_control_state) do nothing useful whenedit.sc_inforeportsenabled:false. - Two tools in this kit can open a modal window and must never be called from an unattended editor:
asset.copy_folder_to_plugin(the engine's advanced copy prompts to save, then confirms) andasset.save_dirtywithprompt:true. Everything else in the kit is dialog-free by construction;asset.consolidatewrites the dirtied packages to disk as part of the operation. import.*andasset.import_fileneed a source file on disk reachable by the editor process; they are not smoke-tested for that reason (seeDocs/dev/KIT_AUTHORING.md).- Collections are project-global state stored next to the project, not content assets: they are not
undoable with
edit.undoandasset.delete_collectionis permanent. Names are sanitised, so"My Set"becomesMy_Set- use the sanitised name in follow-up calls (every reply echoes it). asset.organize_by_class,asset.apply_naming_prefixandasset.delete_empty_foldersmove or delete in bulk: run them once withdryRun:trueand readchanges/foldersfirst, then runasset.fix_redirectorsafterwards.asset.unload_packages,asset.reload_packagesandasset.clear_dirtydiscard work. They refuse dirty packages unlessincludeDirty:true, and anything another tool reported about those packages is stale afterwards.- Data table columns of a user-defined struct have mangled internal names; address them by their
authored name (
asset.data_table_infolists both). Unknown columns are reported inproblemsrather than failing the whole write. asset.get_derived_classesandasset.get_class_ancestorsanswer from the asset registry, which only knows what it scanned: callasset.scan_pathsfirst when a Blueprint was just written to disk outside the editor, andasset.wait_for_registryright after startup.import.get_optionsis the reliable way to find an option key: factory property names differ per engine version, andimport.with_optionsreports unknown keys as warnings inloginstead of failing the import.
Ferramentas
Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de
MaxAutoRiskexigem"_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumentodryRun. smoke = coberto poredit.self_test.
asset.add_to_collection (risco 4, altera, smoke)
Adds assets to a static collection. Missing assets are reported, the rest are still added.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
assets | array of string | obrigatório. Assets to add/remove (object path, package path or unique name). |
Retorna: collection, message, assets, count.
asset.apply_naming_prefix (risco 3, altera, dryRun, smoke)
Renames assets so each class carries its naming prefix (BP_, M_, MI_, T_, SM_, SK_, S_ by default). Run with dryRun first.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
mapping | array of UeaClassFolderRule | Class -> sub-folder / prefix rules. Empty uses the built-in defaults. |
recursive | boolean | Padrão true. |
dryRun | boolean | Only report what would change. Padrão false. |
limit | integer | Padrão 500. |
Retorna: changes, count, failedCount, dryRun, rulesUsed.
asset.asset_manager_scan (risco 1, smoke)
Registers content folders with the asset manager as a primary asset type and scans them.
| Argumento | Tipo | Descrição |
|---|---|---|
paths | array of string | obrigatório. Content folders to scan, e.g. ["/Game/Items"]. |
type | string | obrigatório. Primary asset type to register the results under. |
baseClass | string | obrigatório. Base class of the primary assets, e.g. "PrimaryDataAsset". |
hasBlueprintClasses | boolean | The assets are Blueprint classes rather than instances. Padrão false. |
editorOnly | boolean | Register the type as editor-only. Padrão false. |
Retorna: type, numScanned, assets, message.
asset.checkout (risco 4)
Checks assets out (or marks them for add) in the active source control provider. Not smoke-tested: needs a provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.clear_dirty (risco 3)
Clears the dirty flag without saving (the changes stay in memory but the editor stops offering to save). Not smoke-tested: it would hide real unsaved changes of the session.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.close_all_editors (risco 0, smoke)
Closes every open asset editor window.
Sem argumentos.
Retorna: message.
asset.close_editor (risco 0, smoke)
Closes the editor windows of one asset.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: message.
asset.collection_from_search (risco 4, altera, smoke)
Creates (or refills) a static collection from a registry search: folder + class + name substring.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Name of the collection to create (or fill when it already exists). |
shareType | string | Padrão TEXT("local"). |
folder | string | Folder to search. Default "/Game". |
classFilter | string | Optional class filter, e.g. "Material". |
nameContains | string | Optional name substring filter. |
recursive | boolean | Padrão true. |
limit | integer | Padrão 500. |
Retorna: collection, message, assets, count.
asset.composite_table_set_parents (risco 3, altera)
Sets the parent tables of a CompositeDataTable (lowest priority first). Not smoke-tested: the smoke chain creates no composite table.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. CompositeDataTable asset. |
parents | array of string | obrigatório. Parent data tables, lowest priority first. |
Retorna: asset, rowStruct, columns, rowCount, sampleRows, composite, parentTables.
asset.consolidate (risco 5, altera, destrutivo, smoke)
Consolidates duplicates: every reference to Assets is redirected to Target and the duplicates are deleted.
| Argumento | Tipo | Descrição |
|---|---|---|
target | string | obrigatório. Asset that survives; every reference to the others is redirected to it. |
assets | array of string | obrigatório. Assets to merge into Target and delete. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.copy_folder_to_plugin (risco 4, altera)
Copies a content folder into a plugin's content (advanced copy: dependencies are copied too). INTERACTIVE ONLY: the engine's advanced copy prompts to save and then opens a modal confirmation window, which freezes an unattended editor. Not smoke-tested for that reason.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Source content folder. |
plugin | string | obrigatório. Target plugin name or its mount point ("MyPlugin" or "/MyPlugin"). |
subfolder | string | Sub-folder inside the plugin content, e.g. "Imported". |
Retorna: message.
asset.count (risco 0, smoke)
Number of assets under a folder (optionally of one class).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Root folder. Default "/Game". |
class | string | Optional class filter. |
recursive | boolean | Padrão true. |
Retorna: count, result.
asset.create (risco 2, altera, smoke)
Creates an asset of any class that has a "new asset" factory (Material, SoundCue, DataAsset, ...). Factory properties can be set by name.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Asset class name or path (e.g. "Material", "DataTable", "/Script/Engine.SoundCue"). |
folder | string | obrigatório. |
name | string | obrigatório. |
factory | string | Factory class name (e.g. "MaterialInstanceConstantFactoryNew"). Empty = first factory that can create the class. |
factoryProperties | array of UeaKeyValue | Factory properties to set before creation (e.g. InitialParent, Struct, DataAssetClass). |
save | boolean | Save the new asset to disk immediately. Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_collection (risco 4, altera, smoke)
Creates a collection. Names are sanitised (only letters, digits, "_" and "-" survive). Collections are project-global, not content assets.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Collection name. Characters that collections cannot store are replaced by "_". |
shareType | string | "local" (default), "private" or "shared". Padrão TEXT("local"). |
storageMode | string | "static" (default, a list of assets) or "dynamic" (a saved content-browser query). Padrão TEXT("static"). |
parent | string | Optional parent collection name. |
query | string | Query text for a dynamic collection. |
Retorna: collection, message, assets, count.
asset.create_curve (risco 2, altera, smoke)
Creates a CurveFloat / CurveVector / CurveLinearColor asset.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
type | string | "float", "vector" or "linearcolor". Padrão TEXT("float"). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_data_asset (risco 2, altera, smoke)
Creates a DataAsset (or PrimaryDataAsset) instance of a class (source = class name or Blueprint).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_data_table (risco 2, altera, smoke)
Creates a DataTable for a row struct (source = struct name/path, e.g. "MyRowStruct" or a user-defined struct asset).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_enum (risco 2, altera, smoke)
Creates a user-defined Enum with the given enumerator names.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
values | array of string | obrigatório. Enumerator display names in order. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_folder (risco 1, altera, smoke)
Creates a content folder (and parents).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: message.
asset.create_folders (risco 1, altera, smoke)
Creates a list of content folders (and their parents).
| Argumento | Tipo | Descrição |
|---|---|---|
folders | array of string | obrigatório. Content folders to create, e.g. ["/Game/Art/Textures", "/Game/Art/Materials"]. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.create_font (risco 2, altera, smoke)
Creates a runtime Font asset (add font faces afterwards with object.set_property).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_level (risco 2, altera, smoke)
Creates a new level asset (source = optional template level to copy). Does not open it; use edit.load_map.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_material (risco 2, altera, smoke)
Creates an empty Material.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_material_function (risco 2, altera, smoke)
Creates a Material Function.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_material_instance (risco 2, altera, smoke)
Creates a Material Instance Constant with the given parent material (source).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_object_library (risco 2, altera, smoke)
Creates an ObjectLibrary.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_physical_material (risco 2, altera, smoke)
Creates a PhysicalMaterial (source = optional PhysicalMaterial subclass).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_physics_asset (risco 2, altera)
Creates a PhysicsAsset for a skeletal mesh (source = skeletal mesh) using the default body setup. Not smoke-tested: the factory can open a modal options dialog.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_render_target (risco 2, altera, smoke)
Creates a TextureRenderTarget2D.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
width | integer | Padrão 256. |
height | integer | Padrão 256. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_sound_class (risco 2, altera, smoke)
Creates a SoundClass.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_sound_cue (risco 2, altera, smoke)
Creates a SoundCue (source = optional SoundWave to wire as the first node when supported).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
source | string | Parent material (material instance), row struct (data table), class (data asset / physical material), skeletal mesh (physics asset) or template level (level). |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_sound_mix (risco 2, altera, smoke)
Creates a SoundMix.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_string_table (risco 2, altera, smoke)
Creates a StringTable.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.create_struct (risco 2, altera, smoke)
Creates a user-defined Struct with typed fields.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
name | string | obrigatório. |
fields | array of UeaStructField | obrigatório. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.curve_add_key (risco 2, altera, smoke)
Adds one key to a curve channel.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | |
time | number | obrigatório. |
value | number | obrigatório. |
interp | string | "linear" (default), "constant", "cubic" or "none". Padrão TEXT("linear"). |
Retorna: asset, type, channels.
asset.curve_clear (risco 3, altera, destrutivo, smoke)
Removes every key of a curve (all channels when channel is empty).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | Channel: "value" (float), "x"/"y"/"z" (vector) or "r"/"g"/"b"/"a" (colour). Empty = every channel. |
Retorna: asset, type, channels.
asset.curve_evaluate (risco 0, smoke)
Evaluates a curve at a time (every channel unless one is named).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
time | number | obrigatório. |
channel | string |
Retorna: asset, time, values, value.
asset.curve_get_keys (risco 0, smoke)
Keys of a curve channel (time, value, interpolation, tangents).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | Channel: "value" (float), "x"/"y"/"z" (vector) or "r"/"g"/"b"/"a" (colour). Empty = every channel. |
Retorna: asset, type, channels.
asset.curve_info (risco 0, smoke)
Type and per-channel key statistics of a CurveFloat / CurveVector / CurveLinearColor.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | Channel: "value" (float), "x"/"y"/"z" (vector) or "r"/"g"/"b"/"a" (colour). Empty = every channel. |
Retorna: asset, type, channels.
asset.curve_remove_key (risco 3, altera, destrutivo, smoke)
Removes one key of a curve channel, by index or by time.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | |
index | integer | Index of the key to remove; -1 uses time instead. Padrão -1. |
time | number | Time of the key to remove (used when index is -1). Padrão 0.0. |
tolerance | number | Time tolerance when matching by time. Padrão 0.001. |
Retorna: asset, type, channels.
asset.curve_set_interpolation (risco 2, altera, smoke)
Sets the interpolation mode of every key of a curve channel.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | |
interp | string | obrigatório. "linear", "constant", "cubic" or "none". |
Retorna: asset, type, channels.
asset.curve_set_keys (risco 2, altera, smoke)
Replaces every key of a curve channel.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
channel | string | Channel to replace. Empty = the first channel. |
keys | array of UeaCurveKey | obrigatório. The complete new key list, replacing the current one. |
Retorna: asset, type, channels.
asset.data_asset_get (risco 0, smoke)
Every editable property of a DataAsset with its current value as text.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, class, properties, problems.
asset.data_asset_set (risco 2, altera, smoke)
Writes properties of a DataAsset from their text form.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
values | array of UeaKeyValue | obrigatório. Property -> value as text. |
save | boolean | Padrão false. |
Retorna: asset, class, properties, problems.
asset.data_table_add_row (risco 2, altera, smoke)
Adds a row (default values, then the given cells).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
values | array of UeaKeyValue | Column -> value as text (the same text the details panel accepts). |
Retorna: asset, row, rowCount, problems.
asset.data_table_clear (risco 5, altera, destrutivo, smoke)
Removes every row of a DataTable (the row struct is kept).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, rowStruct, columns, rowCount, sampleRows, composite, parentTables.
asset.data_table_duplicate_row (risco 2, altera, smoke)
Duplicates a row under a new name.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
newName | string | obrigatório. New row name (asset.data_table_rename_row) or the name of the copy (asset.data_table_duplicate_row). |
Retorna: asset, row, rowCount, problems.
asset.data_table_export (risco 0, smoke)
Exports a DataTable as CSV or JSON text (optionally to a file).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
format | string | "csv" (default) or "json". Padrão TEXT("csv"). |
savePath | string | Optional absolute file path to also write. |
Retorna: text, lines, savedTo, problems.
asset.data_table_export_json (risco 0, smoke)
Exports a DataTable as JSON text.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: text, lines, savedTo, problems.
asset.data_table_fill (risco 2, altera, smoke)
Fills a DataTable from CSV or JSON text (or a file). Existing rows are replaced.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
text | string | CSV or JSON text (first CSV column = row name). Ignored when File is set. |
file | string | Absolute path of a .csv / .json file. |
format | string | "csv" (default) or "json". Padrão TEXT("csv"). |
Retorna: text, lines, savedTo, problems.
asset.data_table_find_rows (risco 0, smoke)
Rows whose column matches a value (exact or substring).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
column | string | obrigatório. |
value | string | obrigatório. Value to look for (text form). |
contains | boolean | Substring match instead of equality. Padrão false. |
limit | integer | Padrão 100. |
Retorna: asset, rows, total, returned.
asset.data_table_get_row (risco 0, smoke)
Every cell of one row.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. Row name. |
Retorna: asset, row, rowCount, problems.
asset.data_table_import_csv (risco 3, altera, smoke)
Replaces every row of a DataTable from CSV text (or a .csv file).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
csv | string | CSV text (asset.data_table_import_csv) or JSON text (asset.data_table_import_json). Ignored when file is set. |
json | string | JSON text. Ignored when file is set. |
file | string | Absolute path of a .csv / .json file to read instead. |
Retorna: text, lines, savedTo, problems.
asset.data_table_import_json (risco 3, altera, smoke)
Replaces every row of a DataTable from JSON text (or a .json file).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
csv | string | CSV text (asset.data_table_import_csv) or JSON text (asset.data_table_import_json). Ignored when file is set. |
json | string | JSON text. Ignored when file is set. |
file | string | Absolute path of a .csv / .json file to read instead. |
Retorna: text, lines, savedTo, problems.
asset.data_table_info (risco 0, smoke)
Row struct, columns with their types and row count of a DataTable (or CompositeDataTable).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, rowStruct, columns, rowCount, sampleRows, composite, parentTables.
asset.data_table_list_rows (risco 0, smoke)
Row names of a DataTable, with paging and an optional name filter.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
nameContains | string | Only rows whose name contains this substring. |
includeValues | boolean | Also return every cell of each row. Padrão false. |
limit | integer | Padrão 100. |
offset | integer | Padrão 0. |
Retorna: asset, rows, total, returned.
asset.data_table_remove_row (risco 3, altera, destrutivo, smoke)
Removes one row.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. Row name. |
Retorna: asset, rows, total, returned.
asset.data_table_rename_row (risco 2, altera, smoke)
Renames a row.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
newName | string | obrigatório. New row name (asset.data_table_rename_row) or the name of the copy (asset.data_table_duplicate_row). |
Retorna: asset, row, rowCount, problems.
asset.data_table_reorder_row (risco 2, altera, smoke)
Moves a row up or down in the table order.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
direction | string | "up" or "down". Padrão TEXT("up"). |
steps | integer | How many positions to move (1 or more). Padrão 1. |
Retorna: asset, rows, total, returned.
asset.data_table_set_cell (risco 2, altera, smoke)
Writes one cell of one row.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
column | string | obrigatório. Column name (authored name or internal property name). |
value | string | obrigatório. New value as text. |
Retorna: asset, row, rowCount, problems.
asset.data_table_set_row (risco 2, altera, smoke)
Writes several cells of one row (the row must exist).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
row | string | obrigatório. |
values | array of UeaKeyValue | Column -> value as text (the same text the details panel accepts). |
Retorna: asset, row, rowCount, problems.
asset.data_table_set_row_struct (risco 3, altera, smoke)
Changes the row struct of a DataTable. Every existing row is dropped.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
rowStruct | string | obrigatório. Row struct: a native struct name ("TableRowBase") or a user defined struct asset path. |
Retorna: asset, rowStruct, columns, rowCount, sampleRows, composite, parentTables.
asset.delete (risco 3, altera, destrutivo, smoke)
Deletes an asset. Fails if it is still referenced unless Force is used via settings.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: message.
asset.delete_collection (risco 4, altera, destrutivo, smoke)
Destroys a collection (its assets are untouched). With recursive=true child collections go first.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
recursive | boolean | Also destroy every child collection (depth first). Padrão false. |
Retorna: message.
asset.delete_empty_folders (risco 3, altera, destrutivo, dryRun, smoke)
Deletes the empty content folders under a root. Run with dryRun first.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Root to inspect. Default "/Game". |
dryRun | boolean | Padrão false. |
limit | integer | Padrão 500. |
Retorna: folders, total, deleted, dryRun.
asset.delete_folder (risco 5, altera, destrutivo, smoke)
Deletes a content folder and every asset inside it.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: message.
asset.delete_many (risco 5, altera, destrutivo, smoke)
Deletes many assets. With force=true references are nulled out (dangerous).
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
force | boolean | Force-delete even when the asset is still referenced (references are nulled). Padrão false. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.diff_folders (risco 0, smoke)
Compares two folders by asset name: only in A, only in B, in both.
| Argumento | Tipo | Descrição |
|---|---|---|
a | string | obrigatório. First folder. |
b | string | obrigatório. Second folder. |
recursive | boolean | Padrão true. |
Retorna: onlyInA, onlyInB, inBoth, countA, countB.
asset.duplicate (risco 2, altera, smoke)
Duplicates an asset to a folder under a new name.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
folder | string | Destination folder. Defaults to the source folder. |
newName | string | obrigatório. |
Retorna: asset.
asset.duplicate_folder (risco 2, altera, smoke)
Duplicates a content folder and its assets.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
newFolder | string | obrigatório. |
Retorna: message.
asset.duplicate_many (risco 2, altera, smoke)
Duplicates many assets into a folder (same names).
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
folder | string | obrigatório. Destination content folder. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.empty_collection (risco 4, altera, destrutivo, smoke)
Removes every asset from a collection without destroying it.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. Collection name. Characters that collections cannot store are replaced by "_". |
shareType | string | "local" (default), "private" or "shared". Padrão TEXT("local"). |
Retorna: collection, message, assets, count.
asset.exists (risco 0, smoke)
True when the asset exists; returns its info.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset.
asset.exists_many (risco 0, smoke)
Which of the given assets exist (registry lookup, nothing is loaded).
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: existing, missing.
asset.find (risco 0, smoke)
Finds assets by name substring, folder and class.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | Substring of the asset name (case-insensitive). Empty lists everything under the folder. |
folder | string | Root folder, e.g. "/Game/Characters". Default "/Game". |
class | string | Class filter, e.g. "Blueprint", "StaticMesh", "Texture2D", "World". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.find_blueprints_by_parent (risco 0, smoke)
Finds Blueprint assets whose parent class is (or derives from) the given class.
| Argumento | Tipo | Descrição |
|---|---|---|
parentClass | string | obrigatório. Parent class (native like "Character" or a Blueprint path). |
folder | string | |
includeSubclasses | boolean | Also match Blueprints whose parent is a subclass of ParentClass (loads the Blueprints). Padrão true. |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.find_by_class (risco 0, smoke)
Finds assets by class with explicit control over derived classes and on-disk only results.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Class name or path, e.g. "StaticMesh" or "/Script/Engine.Texture2D". |
folder | string | |
includeDerived | boolean | Include subclasses (e.g. "Texture" also lists Texture2D, TextureCube). Padrão true. |
recursive | boolean | Padrão true. |
onDiskOnly | boolean | Only assets known from disk (skips in-memory only objects). Padrão false. |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.find_by_tag (risco 0, smoke)
Finds assets by asset-registry tag and value (e.g. tag=ParentClass, value contains "Character").
| Argumento | Tipo | Descrição |
|---|---|---|
tag | string | obrigatório. Asset registry tag, e.g. "ParentClass", "RowStructure", "NumFrames". |
value | string | Exact value. Empty = any asset carrying the tag. |
contains | boolean | Substring match on the value instead of equality. Padrão false. |
folder | string | |
class | string | |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.find_circular_dependencies (risco 0, smoke)
Detects dependency cycles that go through the asset (A -> B -> A).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
hard | boolean | Include hard references (default true). Padrão true. |
soft | boolean | Include soft references (default true). Padrão true. |
recursive | boolean | Walk transitively. Padrão false. |
maxDepth | integer | Maximum depth when recursive (1-10). Padrão 3. |
includeScript | boolean | Include /Script/ (native code) packages. Padrão false. |
limit | integer | Padrão 500. |
Retorna: root, cycles, packagesVisited.
asset.find_duplicates_by_name (risco 0, smoke)
Assets sharing the same name in different folders.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Folder to audit. Default "/Game". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 200. |
Retorna: duplicates, total.
asset.find_missing_references (risco 0, smoke)
References (hard and soft) in a folder that point at packages which no longer exist.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Folder to audit. Default "/Game". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 200. |
Retorna: missing, assetsChecked, total.
asset.find_naming_violations (risco 0, smoke)
Assets whose name does not carry the prefix expected for their class.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
mapping | array of UeaClassFolderRule | Class -> sub-folder / prefix rules. Empty uses the built-in defaults. |
recursive | boolean | Padrão true. |
dryRun | boolean | Only report what would change. Padrão false. |
limit | integer | Padrão 500. |
Retorna: changes, count, failedCount, dryRun, rulesUsed.
asset.find_orphans (risco 0, smoke)
Assets in a folder that nothing outside that folder references (cleanup candidates).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Folder to audit. Default "/Game". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 200. |
Retorna: assets, total, returned, offset.
asset.find_unused (risco 0, smoke)
Assets nothing references (candidates for cleanup). Maps and assets referenced only by /Script/ count as unused.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Class name or path, e.g. "StaticMesh" or "/Script/Engine.Texture2D". |
folder | string | |
includeDerived | boolean | Include subclasses (e.g. "Texture" also lists Texture2D, TextureCube). Padrão true. |
recursive | boolean | Padrão true. |
onDiskOnly | boolean | Only assets known from disk (skips in-memory only objects). Padrão false. |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.fix_redirectors (risco 3, altera, dryRun, smoke)
Fixes up (and deletes) redirectors under a folder so referencers point at the real assets. Loads the referencing packages and rewrites them in memory; pass save=true to write them to disk. Use dryRun=true first to see what would change.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Folder to scan for redirectors, e.g. "/Game". |
recursive | boolean | Padrão true. |
dryRun | boolean | Only report the redirectors and their referencers; nothing is loaded, changed or deleted. Padrão false. |
save | boolean | Write the updated referencing packages (and the deletions) to disk. Without it the fix-up only lives in memory until something saves. Padrão false. |
Retorna: redirectors, referencers, fixed, deleted, saved, failed, dryRun.
asset.folder_has_assets (risco 0, smoke)
Whether a folder contains assets (count under it).
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: count, result.
asset.fully_load (risco 1, smoke)
Fully loads a package so every object inside it is in memory.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: package, file, sizeBytes, existsOnDisk, loaded, fullyLoaded, dirty, isMap, cooked, external, flags, objects, modifiedUtc.
asset.get_asset_collections (risco 0, smoke)
Collections that contain an asset.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Asset whose collections are listed. |
recursive | boolean | Also report collections that contain the asset through a child collection. Padrão false. |
Retorna: collections, total.
asset.get_asset_size_breakdown (risco 0, smoke)
Disk size of a folder grouped by asset class or by sub-folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
groupBy | string | "class" (default) or "subfolder". Padrão TEXT("class"). |
recursive | boolean | Padrão true. |
limit | integer | Padrão 100. |
Retorna: groups, totalBytes, assetCount, missingOnDisk.
asset.get_browser_folder (risco 0, smoke)
Folder currently open in the Content Browser.
Sem argumentos.
Retorna: folder, selectedFolders.
asset.get_browser_selection (risco 0, smoke)
Assets and folders selected in the Content Browser.
Sem argumentos.
Retorna: assets, folders.
asset.get_by_package (risco 0, smoke)
Assets stored in one package (a package can hold more than one object).
| Argumento | Tipo | Descrição |
|---|---|---|
package | string | obrigatório. Package name, e.g. "/Game/Art/M_Wall". |
includeTags | boolean | Padrão false. |
Retorna: assets, total, returned, offset.
asset.get_class_ancestors (risco 0, smoke)
Ancestor classes of a class, nearest parent first.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Class name or path, e.g. "Actor" or "/Script/Engine.Actor". |
recursive | boolean | Walk the whole subtree instead of the direct children only. Padrão true. |
limit | integer | Padrão 500. |
Retorna: class, classes, total.
asset.get_collection_assets (risco 0, smoke)
Object paths held by a collection, optionally including its child collections.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
recursive | boolean | Include the assets of child collections. Padrão false. |
limit | integer | Padrão 500. |
Retorna: collection, message, assets, count.
asset.get_dependencies (risco 0, smoke)
Packages the asset depends on, hard/soft, optionally transitive with depth.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
hard | boolean | Include hard references (default true). Padrão true. |
soft | boolean | Include soft references (default true). Padrão true. |
recursive | boolean | Walk transitively. Padrão false. |
maxDepth | integer | Maximum depth when recursive (1-10). Padrão 3. |
includeScript | boolean | Include /Script/ (native code) packages. Padrão false. |
limit | integer | Padrão 500. |
Retorna: root, entries, total.
asset.get_dependency_graph (risco 0, smoke)
Dependency graph below an asset as edges, up to depth 4, per reference category.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
depth | integer | Walk depth, 1-4. Padrão 2. |
hard | boolean | Include hard package references. Padrão true. |
soft | boolean | Include soft package references. Padrão true. |
searchable | boolean | Include searchable-name dependencies (gameplay tags, curve rows, ...). Padrão false. |
manage | boolean | Include asset-manager "manage" dependencies. Padrão false. |
includeScript | boolean | Include /Script/ (native code) packages. Padrão false. |
limit | integer | Padrão 500. |
Retorna: root, nodes, edges, nodeCount, edgeCount, truncated.
asset.get_derived_classes (risco 0, smoke)
Subclasses of a class known to the asset registry (native classes and Blueprint generated classes).
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Class name or path, e.g. "Actor" or "/Script/Engine.Actor". |
recursive | boolean | Walk the whole subtree instead of the direct children only. Padrão true. |
limit | integer | Padrão 500. |
Retorna: class, classes, total.
asset.get_file_info (risco 0, smoke)
Package file path, size and timestamp on disk, dirty/loaded/cooked state.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, package, file, sizeBytes, modifiedUtc, existsOnDisk, loaded, dirty, cooked, isMap, isRedirector.
asset.get_metadata (risco 0, smoke)
Editor metadata tags stored on the asset (UMetaData).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: entries, count.
asset.get_open_editors (risco 0, smoke)
Assets currently open in asset editor windows.
Sem argumentos.
Retorna: assets, total.
asset.get_package_info (risco 0, smoke)
Package of an asset: file on disk, size, load/dirty state, package flags and the objects it holds.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: package, file, sizeBytes, existsOnDisk, loaded, fullyLoaded, dirty, isMap, cooked, external, flags, objects, modifiedUtc.
asset.get_primary_asset_id (risco 0, smoke)
Primary asset id of an asset (empty when it is not a primary asset).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, primaryAssetId, type, isPrimaryAsset.
asset.get_referencer_graph (risco 0, smoke)
Referencer graph above an asset as edges, up to depth 4, per reference category.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
depth | integer | Walk depth, 1-4. Padrão 2. |
hard | boolean | Include hard package references. Padrão true. |
soft | boolean | Include soft package references. Padrão true. |
searchable | boolean | Include searchable-name dependencies (gameplay tags, curve rows, ...). Padrão false. |
manage | boolean | Include asset-manager "manage" dependencies. Padrão false. |
includeScript | boolean | Include /Script/ (native code) packages. Padrão false. |
limit | integer | Padrão 500. |
Retorna: root, nodes, edges, nodeCount, edgeCount, truncated.
asset.get_referencers (risco 0, smoke)
Packages that reference the asset, optionally transitive with depth.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
hard | boolean | Include hard references (default true). Padrão true. |
soft | boolean | Include soft references (default true). Padrão true. |
recursive | boolean | Walk transitively. Padrão false. |
maxDepth | integer | Maximum depth when recursive (1-10). Padrão 3. |
includeScript | boolean | Include /Script/ (native code) packages. Padrão false. |
limit | integer | Padrão 500. |
Retorna: root, entries, total.
asset.get_registry_tags (risco 0, smoke)
Asset registry tags of an asset (ParentClass, NumVertices, RowStructure, ...).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: entries, count.
asset.get_size_report (risco 0, smoke)
Largest assets on disk under a folder (optionally one class) plus total size per class.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | |
class | string | |
recursive | boolean | Padrão true. |
limit | integer | Padrão 50. |
Retorna: largest, byClass, totalBytes, assetCount.
asset.get_source_control_state (risco 0, smoke)
Source control state of assets (provider, checked out, modified, who has it).
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: enabled, provider, states.
asset.get_state_many (risco 0, smoke)
Existence, loaded/dirty state and size of many assets in one call.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: states, existingCount, missingCount.
asset.get_summary (risco 0, smoke)
Class, parent, dirty state, dependencies, referencers and editable properties of an asset.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, parentClass, dirty, dependencies, referencers, properties.
asset.import_file (risco 2, altera)
Imports a file from disk (FBX, PNG, WAV, ...) into a content folder using the engine importers.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute path of a file on disk (FBX, PNG, WAV, ...). |
folder | string | obrigatório. Destination content folder. |
name | string | Optional asset name; defaults to the file name. |
Retorna: assets, total.
asset.label_add_assets (risco 2, altera)
Sem descrição.
Sem argumentos.
asset.label_get (risco 0)
Sem descrição.
Sem argumentos.
asset.label_remove_assets (risco 3, altera, destrutivo)
Sem descrição.
Sem argumentos.
asset.label_set_flags (risco 2, altera)
Sem descrição.
Sem argumentos.
asset.label_set_redirectors (risco 2, altera, UE 5.8+)
Sem descrição.
Sem argumentos.
asset.list_by_tag_value (risco 0, smoke)
Assets whose registry tag has exactly the given value.
| Argumento | Tipo | Descrição |
|---|---|---|
tag | string | obrigatório. Registry tag key, e.g. "ParentClass" or "RowStructure". |
value | string | obrigatório. Exact tag value to match. |
folder | string | Folder to restrict the query to. Default "/Game". |
limit | integer | Padrão 200. |
Retorna: assets, total, returned, offset.
asset.list_classes (risco 0, smoke)
Distinct asset classes under a folder with counts.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Root folder. Default "/Game". |
class | string | Optional class filter. |
recursive | boolean | Padrão true. |
Retorna: classes, total.
asset.list_collections (risco 0, smoke)
Lists content-browser collections with share type, storage mode, parent and asset count.
| Argumento | Tipo | Descrição |
|---|---|---|
contains | string | Substring filter on the collection name. Empty lists every collection. |
shareType | string | "local" (default), "private", "shared", "system" or "all". Padrão TEXT("all"). |
includeCounts | boolean | Also report how many assets each collection holds (slower). Padrão true. |
Retorna: collections, total.
asset.list_content_plugins (risco 0, smoke)
Enabled plugins that ship content, with their mount point and asset count.
Sem argumentos.
Retorna: plugins, total.
asset.list_data_assets (risco 0, smoke)
DataAssets of a class under a folder.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | Data asset class filter, e.g. "PrimaryDataAsset". Default "DataAsset". |
folder | string | |
recursive | boolean | Padrão true. |
limit | integer | Padrão 200. |
Retorna: assets, total.
asset.list_dirty (risco 0, smoke)
Content and map packages with unsaved changes.
Sem argumentos.
Retorna: packages, total, dirtyCount.
asset.list_empty_folders (risco 0, smoke)
Content folders under a root that contain no assets at all.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Root to inspect. Default "/Game". |
dryRun | boolean | Padrão false. |
limit | integer | Padrão 500. |
Retorna: folders, total, deleted, dryRun.
asset.list_factories (risco 0, smoke)
Lists asset factories: which class each creates, whether it can create new assets and the file extensions it imports.
| Argumento | Tipo | Descrição |
|---|---|---|
contains | string | Substring filter on factory or supported class name. |
limit | integer | Padrão 300. |
Retorna: factories, total.
asset.list_folder (risco 0, smoke)
Lists the sub-folders and assets directly inside a content folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: subFolders, assets.
asset.list_largest (risco 0, smoke)
Largest assets on disk under a folder, biggest first.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | |
class | string | |
recursive | boolean | Padrão true. |
limit | integer | Padrão 20. |
Retorna: assets, totalBytes.
asset.list_loaded_packages (risco 0, smoke)
Content packages currently loaded in the editor, optionally only the dirty ones.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Only report packages under this folder. Empty reports every loaded content package. |
dirtyOnly | boolean | Only packages with unsaved changes. Padrão false. |
limit | integer | Padrão 200. |
Retorna: packages, total, dirtyCount.
asset.list_mount_points (risco 0, smoke)
Registered content roots ("/Game/", "/Engine/", plugin mounts) and the folders backing them.
Sem argumentos.
Retorna: mountPoints, total.
asset.list_paths (risco 0, smoke)
Content sub-paths known to the registry under a base folder.
| Argumento | Tipo | Descrição |
|---|---|---|
base | string | Base content folder. Default "/Game". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 1000. |
Retorna: paths, total.
asset.list_primary_assets (risco 0, smoke)
Primary assets registered with the asset manager, optionally of one type.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | Primary asset type, e.g. "Map" or "PrimaryAssetLabel". Empty lists every registered type. |
limit | integer | Padrão 200. |
Retorna: assets, types, total.
asset.list_recent (risco 0, smoke)
Most recently modified asset files on disk under a folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | |
class | string | |
recursive | boolean | Padrão true. |
limit | integer | Padrão 50. |
Retorna: assets.
asset.list_redirectors (risco 0, smoke)
Lists object redirectors left behind by renames/moves under a folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: assets, total.
asset.list_tags_of_class (risco 0, smoke)
Distinct registry tag keys seen on assets of a class, with an example value each.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | obrigatório. Class name or path, e.g. "StaticMesh". |
folder | string | |
recursiveClasses | boolean | Also inspect assets of subclasses. Padrão true. |
sampleSize | integer | Maximum number of assets to sample. Padrão 50. |
Retorna: tags, assetsSampled.
asset.make_unique_name (risco 0, smoke)
Finds a free asset name in a folder by appending a counter when needed.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
base | string | obrigatório. Base asset name. |
suffix | string | Suffix appended before the uniqueness counter, e.g. "_Copy". |
Retorna: name, path, unchanged.
asset.manager_get_asset_bundles (risco 0)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
primaryAssetId | string | obrigatório. Primary asset id formatted Type:Name. |
asset.manager_get_bundle_state (risco 0, smoke)
Sem descrição.
Sem argumentos.
asset.manager_get_load_set (risco 0)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
bundles | array of string | Asset bundles to load, such as Client or Server. |
recursive | boolean | Include recursively managed primary assets in the load-set audit. Padrão false. |
asset.manager_get_rules (risco 0)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
primaryAssetId | string | obrigatório. Primary asset id formatted Type:Name. |
asset.manager_get_type (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Primary asset type, such as Map or PrimaryAssetLabel. |
asset.manager_list_assets_in_path (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
path | string | obrigatório. Content path to intersect with the registered primary assets. |
limit | integer | Maximum returned primary assets. Padrão 200. |
asset.manager_list_type_assets (risco 0, smoke)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
type | string | obrigatório. Primary asset type, such as Map or PrimaryAssetLabel. |
asset.manager_load_primary (risco 1)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
bundles | array of string | Asset bundles to load, such as Client or Server. |
recursive | boolean | Include recursively managed primary assets in the load-set audit. Padrão false. |
asset.manager_status (risco 0, smoke)
Sem descrição.
Sem argumentos.
asset.manager_unload_primary (risco 1)
Sem descrição.
| Argumento | Tipo | Descrição |
|---|---|---|
primaryAssetId | string | obrigatório. Primary asset id formatted Type:Name. |
asset.mark_dirty (risco 1, altera, smoke)
Marks packages dirty so the editor offers to save them.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.move (risco 2, altera, smoke)
Moves an asset to another content folder (keeps the name, fixes up referencers).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
folder | string | obrigatório. Destination content folder, e.g. "/Game/Characters/Hero". |
Retorna: asset.
asset.move_folder (risco 3, altera, smoke)
Moves a content folder (with every asset in it) under another parent folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Folder to move, e.g. "/Game/Art/Old". |
newParent | string | obrigatório. New parent folder, e.g. "/Game/Archive". The folder keeps its own name. |
Retorna: message.
asset.move_many (risco 2, altera, smoke)
Moves many assets to one folder. Reports per-asset failures instead of stopping.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
folder | string | obrigatório. Destination content folder. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.open_editor (risco 1)
Opens the asset in its editor window.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset.
asset.organize_by_class (risco 3, altera, dryRun, smoke)
Moves assets of a folder into per-class sub-folders (Blueprints/Materials/Textures/Meshes/Sounds by default). Run with dryRun first.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
mapping | array of UeaClassFolderRule | Class -> sub-folder / prefix rules. Empty uses the built-in defaults. |
recursive | boolean | Padrão true. |
dryRun | boolean | Only report what would change. Padrão false. |
limit | integer | Padrão 500. |
Retorna: changes, count, failedCount, dryRun, rulesUsed.
asset.path_exists (risco 0, smoke)
Whether a content folder is known to the registry and/or exists on disk, and how many assets it holds.
| Argumento | Tipo | Descrição |
|---|---|---|
path | string | obrigatório. Content folder to test, e.g. "/Game/Art". |
Retorna: path, knownToRegistry, existsOnDisk, assetCount.
asset.preview (risco 0, smoke)
Thumbnail of any asset that has a thumbnail renderer (materials, meshes, textures, Blueprints, widgets, Niagara systems, ...) returned as an image.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Asset (object path, package path or unique name). |
size | integer | Thumbnail edge in pixels (32-1024). Padrão 256. |
format | string | png or jpg. Padrão TEXT("png"). |
Retorna: width, height, savedTo, imageBase64, imageMimeType.
asset.query (risco 0, smoke)
Full asset-registry query: folders, classes, tags and package names in one filter, with limit/offset paging.
| Argumento | Tipo | Descrição |
|---|---|---|
packagePaths | array of string | Content folders to search, e.g. ["/Game/Art"]. Empty searches "/Game". |
classes | array of string | Class names or paths, e.g. ["Material", "Texture2D"]. |
recursiveClasses | boolean | Also match subclasses of the listed classes. Padrão true. |
recursivePaths | boolean | Search sub-folders. Padrão true. |
tags | array of UeaKeyValue | Tag filters; an empty value matches any asset carrying the tag. |
packageNames | array of string | Exact package names to restrict the query to. |
onDiskOnly | boolean | Only assets known from disk (skips in-memory only objects). Padrão false. |
includeTags | boolean | Return every registry tag of each asset. Padrão false. |
limit | integer | Padrão 200. |
offset | integer | Padrão 0. |
Retorna: assets, total, returned, offset.
asset.registry_status (risco 0, smoke)
Asset registry state: still loading, number of known assets and cached paths.
Sem argumentos.
Retorna: loadingAssets, totalAssets, cachedPaths, elapsedSeconds, message.
asset.reload_packages (risco 3)
Reloads packages from disk, discarding in-memory changes. Not smoke-tested: reloading during a test run invalidates fixtures.
| Argumento | Tipo | Descrição |
|---|---|---|
packages | array of string | obrigatório. Package names ("/Game/Folder/Asset") or asset references. |
includeDirty | boolean | Unload/reload even when the package has unsaved changes (the changes are lost). Padrão false. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.remove_from_collection (risco 4, altera, smoke)
Removes assets from a static collection.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
assets | array of string | obrigatório. Assets to add/remove (object path, package path or unique name). |
Retorna: collection, message, assets, count.
asset.remove_metadata (risco 2, altera, smoke)
Removes an editor metadata tag.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
key | string | obrigatório. |
value | string | Used by asset.set_metadata. |
Retorna: entries, count.
asset.rename (risco 2, altera, smoke)
Renames or moves an asset (fixes up referencers).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
folder | string | Destination folder. Defaults to the source folder. |
newName | string | obrigatório. |
Retorna: asset.
asset.rename_collection (risco 4, altera, smoke)
Renames a collection and optionally moves it to another share type.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
newName | string | obrigatório. |
newShareType | string | New share type; empty keeps the current one. |
Retorna: collection, message, assets, count.
asset.rename_folder (risco 2, altera, smoke)
Renames/moves a content folder with all its assets.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
newFolder | string | obrigatório. |
Retorna: message.
asset.rename_many (risco 2, altera, dryRun, smoke)
Bulk rename by find/replace, prefix and suffix under a folder. Use dryRun to preview.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Folder whose assets are renamed. Default "/Game". |
find | string | Substring to look for in the asset name (case-insensitive). Empty = match every asset. |
replace | string | Replacement for Find. |
prefix | string | Prefix added when the name does not already start with it. |
suffix | string | Suffix added when the name does not already end with it. |
class | string | Optional class filter (e.g. "Texture2D"). |
recursive | boolean | Padrão true. |
dryRun | boolean | Only report what would be renamed. Padrão false. |
limit | integer | Padrão 500. |
Retorna: renames, failed, count, dryRun.
asset.render_thumbnail (risco 0, smoke)
Renders the asset thumbnail (mesh, material, texture, Blueprint, ...) and returns it as a PNG image block.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
size | integer | Square size in pixels (32-1024). Padrão 256. |
savePath | string | Optional absolute PNG path to also write on disk. |
Retorna: width, height, savedTo, imageBase64, imageMimeType.
asset.reparent_collection (risco 4, altera, smoke)
Nests a collection under a parent collection (empty parent = make it a root collection).
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
parent | string | New parent collection name; empty makes the collection a root collection. |
parentShareType | string | Padrão TEXT("local"). |
Retorna: collection, message, assets, count.
asset.revert (risco 5, destrutivo)
Reverts assets to the source control head revision (local changes are lost). Not smoke-tested: needs a provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sanitize_name (risco 0, smoke)
Turns arbitrary text into a valid asset/package name (invalid characters become "_").
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Name to sanitise. |
Retorna: name, path, unchanged.
asset.save (risco 2)
Saves one asset to disk.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset.
asset.save_all (risco 2)
Saves every dirty asset and level.
Sem argumentos.
Retorna: savedCount.
asset.save_dirty (risco 2)
Saves every dirty package to disk. Leave prompt=false: prompt=true opens a modal save dialog that freezes an unattended editor. Not smoke-tested: it would write the session's real unsaved work.
| Argumento | Tipo | Descrição |
|---|---|---|
prompt | boolean | Show the "save these packages?" dialog instead of saving silently. Never set this from an automated session: the dialog is modal and blocks the editor. Padrão false. |
includeMaps | boolean | Also save dirty map (level) packages. Padrão true. |
includeContent | boolean | Also save dirty content packages. Padrão true. |
Retorna: savedCount.
asset.save_many (risco 2)
Saves many assets (only dirty ones unless they are unsaved). Not smoke-tested: writes packages to disk.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_add_many (risco 4)
Marks assets for add. Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Assets (object or package paths) to act on. |
updateStatus | boolean | Also refresh the provider state before acting (slower, more accurate). Padrão true. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_checkin (risco 4)
Submits assets with a description. Not smoke-tested: it would publish changes to the team.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
description | string | obrigatório. Changelist / commit description. |
keepCheckedOut | boolean | Keep the files checked out after submitting. Padrão false. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_checkout_many (risco 4)
Checks assets out. Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Assets (object or package paths) to act on. |
updateStatus | boolean | Also refresh the provider state before acting (slower, more accurate). Padrão true. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_diff_against_depot (risco 0)
Fetches the head revision of an asset and reports whether the local file differs from it. Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, localFile, depotRevision, depotFile, differs, localBytes, depotBytes, message.
asset.sc_get_provider (risco 0, smoke)
Active source control provider, whether it is enabled and reachable, and its status lines.
Sem argumentos.
Retorna: provider, enabled, available, status.
asset.sc_history (risco 0)
Revision history of one asset (revision, user, date, description). Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
limit | integer | Padrão 20. |
Retorna: asset, file, revisions, total.
asset.sc_list_changed (risco 0)
Locally modified, added or deleted files under a folder. Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | Content folder to inspect. Default "/Game". |
recursive | boolean | Padrão true. |
limit | integer | Padrão 500. |
Retorna: provider, modified, added, deleted, filesChecked.
asset.sc_lock (risco 4)
Takes an exclusive lock on assets where the provider supports locking (Perforce: an exclusive check out). Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Assets (object or package paths) to act on. |
updateStatus | boolean | Also refresh the provider state before acting (slower, more accurate). Padrão true. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_revert_many (risco 5, destrutivo)
Reverts assets to the head revision (local changes are lost). Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
unchangedOnly | boolean | Only revert files that are checked out but not actually modified. Padrão false. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_status (risco 0, smoke)
Detailed source control state of assets: checked out (and by whom), modified, added, deleted, current.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Assets (object or package paths) to act on. |
updateStatus | boolean | Also refresh the provider state before acting (slower, more accurate). Padrão true. |
Retorna: provider, enabled, states, checkedOutCount, modifiedCount.
asset.sc_sync (risco 3)
Syncs assets (or a whole folder) to the head revision. Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | Assets to sync. Ignored when folder is set. |
folder | string | Content folder to sync instead of individual assets. |
recursive | boolean | Padrão true. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.sc_unlock (risco 4)
Releases the lock on assets (reverts an unchanged exclusive check out). Not smoke-tested: needs an enabled source control provider.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Assets (object or package paths) to act on. |
updateStatus | boolean | Also refresh the provider state before acting (slower, more accurate). Padrão true. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.scan_files (risco 1, smoke)
Scans individual package files synchronously. Paths may be long package names or files on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
paths | array of string | obrigatório. Content folders (or, for asset.scan_files, package/file paths) to scan. |
force | boolean | Rescan even when the registry already knows the path. Padrão false. |
Retorna: loadingAssets, totalAssets, cachedPaths, elapsedSeconds, message.
asset.scan_paths (risco 1, smoke)
Scans content folders synchronously so newly added files show up in the registry.
| Argumento | Tipo | Descrição |
|---|---|---|
paths | array of string | obrigatório. Content folders (or, for asset.scan_files, package/file paths) to scan. |
force | boolean | Rescan even when the registry already knows the path. Padrão false. |
Retorna: loadingAssets, totalAssets, cachedPaths, elapsedSeconds, message.
asset.set_browser_folder (risco 0, smoke)
Navigates the Content Browser to a folder.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. Content folder, e.g. "/Game/Levels". |
recursive | boolean | Padrão false. |
Retorna: folder, selectedFolders.
asset.set_collection_color (risco 4, altera, smoke)
Sets (or clears) the content-browser colour of a collection.
| Argumento | Tipo | Descrição |
|---|---|---|
collection | string | obrigatório. |
shareType | string | Padrão TEXT("local"). |
r | number | Red 0-1. Padrão 1.0. |
g | number | Green 0-1. Padrão 1.0. |
b | number | Blue 0-1. Padrão 1.0. |
a | number | Alpha 0-1. Padrão 1.0. |
clear | boolean | Clear the colour instead of setting it. Padrão false. |
Retorna: collection, message, assets, count.
asset.set_metadata (risco 2, altera, smoke)
Sets an editor metadata tag on the asset.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
key | string | obrigatório. |
value | string | Used by asset.set_metadata. |
Retorna: entries, count.
asset.set_texture_settings (risco 2, altera, smoke)
Changes texture import settings after import: compression, sRGB, max size, group, mip generation.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
srgb | integer | -1 keeps, 0 = linear, 1 = sRGB. Padrão -1. |
compression | string | e.g. "TC_Default", "TC_Normalmap", "TC_Masks". |
lodGroup | string | e.g. "TEXTUREGROUP_World", "TEXTUREGROUP_UI". |
mipGen | string | e.g. "TMGS_NoMipmaps", "TMGS_FromTextureGroup". |
maxSize | integer | 0 keeps; otherwise the maximum texture size in pixels (power of two). Padrão 0. |
neverStream | integer | -1 keeps, 0/1 sets NeverStream. Padrão -1. |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
asset.split_path (risco 0, smoke)
Splits a path into package, asset, sub-object, mount point and file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
path | string | obrigatório. Package path, object path or folder, e.g. "/Game/F/A.A:Sub". |
Retorna: package, assetName, subObject, mountPoint, folder, file.
asset.string_table_export_csv (risco 0, smoke)
Exports a StringTable as CSV text (optionally also to a file).
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
savePath | string | Optional absolute .csv path to also write. |
Retorna: text, lines, savedTo, problems.
asset.string_table_find (risco 0, smoke)
Searches the keys and source strings of a StringTable.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
contains | string | Substring to look for in keys and source strings. |
keysOnly | boolean | Only match the key, not the source string. Padrão false. |
limit | integer | Padrão 200. |
Retorna: entries, count.
asset.string_table_import_csv (risco 2, altera, smoke)
Imports StringTable entries from CSV text (or a .csv file) with a "Key,SourceString" header.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
csv | string | CSV text with a "Key,SourceString" header. Ignored when file is set. |
file | string | Absolute .csv path to read instead. |
replace | boolean | Remove the existing entries before importing. Padrão false. |
Retorna: entries, count.
asset.string_table_list (risco 0, smoke)
Key/source-string entries of a StringTable.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: entries, count.
asset.string_table_remove (risco 3, altera, destrutivo, smoke)
Removes one entry of a StringTable.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
key | string | obrigatório. Entry key to remove. |
Retorna: entries, count.
asset.string_table_set (risco 2, altera, smoke)
Adds or updates StringTable entries.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
entries | array of UeaKeyValue | obrigatório. Key -> source string pairs. |
Retorna: entries, count.
asset.sync_browser (risco 0, smoke)
Selects the assets in the Content Browser and scrolls to them.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: message.
asset.unload_packages (risco 3)
Unloads packages from memory (unsaved changes are lost unless includeDirty is false). Not smoke-tested: unloading packages during a test run breaks later tools.
| Argumento | Tipo | Descrição |
|---|---|---|
packages | array of string | obrigatório. Package names ("/Game/Folder/Asset") or asset references. |
includeDirty | boolean | Unload/reload even when the package has unsaved changes (the changes are lost). Padrão false. |
Retorna: succeeded, failed, succeededCount, failedCount.
asset.validate (risco 0, smoke)
Runs the data validation (IsDataValid + registered validators) on assets.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. Asset references (object path, package path or unique bare name). |
Retorna: results, invalidCount.
asset.validate_path (risco 0, smoke)
Whether a path is a valid long package name and/or object path, with the reason when it is not.
| Argumento | Tipo | Descrição |
|---|---|---|
path | string | obrigatório. Package path, object path or folder, e.g. "/Game/F/A.A:Sub". |
Retorna: path, validLongPackageName, validObjectPath, exists, reason.
asset.wait_for_registry (risco 1, smoke)
Waits (letting editor frames pass) until the asset registry finished its initial scan.
| Argumento | Tipo | Descrição |
|---|---|---|
timeoutSeconds | number | Give up after this many seconds (1-600). Padrão 60.0. |
Retorna: loadingAssets, totalAssets, cachedPaths, elapsedSeconds, message.
import.animation (risco 2, altera)
Imports an animation sequence from FBX onto a skeleton. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
skeleton | string | obrigatório. Skeleton the animation targets. |
importScale | number | Padrão 1.0. |
save | boolean | Padrão false. |
Retorna: assets, total.
import.audio (risco 2, altera)
Imports a sound wave with compression quality, looping and an optional sound class. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
compressionQuality | integer | 1-100; -1 keeps the importer default. Padrão -1. |
looping | boolean | Padrão false. |
soundGroup | string | Sound class / group asset to assign, when given. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.batch (risco 2, altera)
Imports many files in one ImportAssetTasks call, each with its own factory and options. Not smoke-tested: needs source files on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
tasks | array of UeaImportTaskSpec | obrigatório. One entry per file to import. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.can_reimport (risco 0, smoke)
Whether an asset can be reimported, and from which source files.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, canReimport, sourceFiles, reason.
import.csv_to_data_table (risco 2, altera)
Creates a DataTable from a CSV file and a row struct. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute .csv / .json path. |
rowStruct | string | obrigatório. Row struct: a native struct name or a user defined struct asset path. |
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.export (risco 0)
Exports an asset to a file on disk using the engine exporter matching the extension. Not smoke-tested: writes a file outside the content sandbox.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | obrigatório. Absolute destination file. The extension selects the exporter (fbx, obj, png, tga, wav, csv, json, t3d, copy). |
Retorna: file, exporter, sizeBytes, errors.
import.export_data_table_csv (risco 0)
Exports a DataTable to a .csv file on disk. Not smoke-tested: writes files outside the content sandbox.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | obrigatório. Absolute destination file. |
options | array of UeaKeyValue | Exporter properties as text. |
Retorna: results, succeededCount, failedCount.
import.export_many (risco 0)
Exports many assets into a directory, one file each. Not smoke-tested: writes files outside the content sandbox.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
directory | string | obrigatório. Absolute destination directory. |
extension | string | Force one extension for every asset (e.g. "fbx"); empty picks the exporter default. |
Retorna: results, succeededCount, failedCount.
import.export_texture (risco 0)
Exports a texture to PNG/TGA/EXR/HDR. Not smoke-tested: writes files outside the content sandbox.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | obrigatório. Absolute destination file. |
options | array of UeaKeyValue | Exporter properties as text. |
Retorna: results, succeededCount, failedCount.
import.export_to_fbx (risco 0)
Exports a mesh, animation or level to FBX with exporter options. Not smoke-tested: writes files outside the content sandbox.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | obrigatório. Absolute destination file. |
options | array of UeaKeyValue | Exporter properties as text. |
Retorna: results, succeededCount, failedCount.
import.fbx_animation (risco 2, altera)
Imports an animation sequence from FBX onto a skeleton, optionally a frame range only. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
skeleton | string | obrigatório. Skeleton the animation targets. |
importAllFrames | boolean | Padrão true. |
frameStart | integer | First frame to import when importAllFrames is false. Padrão 0. |
frameEnd | integer | Last frame to import when importAllFrames is false. Padrão 0. |
uniformScale | number | Padrão 1.0. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.fbx_skeletal_mesh (risco 2, altera)
Imports a skeletal mesh from FBX (skeleton, morph targets, physics asset). Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
skeleton | string | Existing skeleton to bind to; empty creates a new one. |
importMorphTargets | boolean | Padrão true. |
importAnimations | boolean | Padrão false. |
createPhysicsAsset | boolean | Padrão true. |
importMaterials | boolean | Padrão true. |
uniformScale | number | Padrão 1.0. |
convertScene | boolean | Padrão true. |
forceFrontXAxis | boolean | Padrão false. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.fbx_static_mesh (risco 2, altera)
Imports a static mesh from FBX/OBJ with the usual mesh options. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
generateLightmapUVs | boolean | Padrão true. |
autoGenerateCollision | boolean | Padrão true. |
combineMeshes | boolean | Merge every mesh of the file into one asset. Padrão true. |
importMaterials | boolean | Padrão true. |
importTextures | boolean | Padrão true. |
uniformScale | number | Padrão 1.0. |
convertScene | boolean | Convert the scene axes to Unreal's. Padrão true. |
forceFrontXAxis | boolean | Use -X as the front axis. Padrão false. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.files (risco 2, altera)
Imports many files with the automatic importer (no dialogs). Not smoke-tested: needs source files on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
files | array of string | obrigatório. Absolute file paths. |
folder | string | obrigatório. |
Retorna: assets, total.
import.get_last_import_log (risco 0, smoke)
Log lines (warnings and errors) captured during the last import or export tool call of this kit.
Sem argumentos.
Retorna: lines, tool, warningCount, errorCount.
import.get_options (risco 0, smoke)
Editable options of the factory that imports a file extension, with their defaults, ready to pass to import.with_options.
| Argumento | Tipo | Descrição |
|---|---|---|
format | string | obrigatório. File extension or file name, e.g. "fbx", ".png" or "C:/mesh.fbx". |
includeOptionsObject | boolean | Also list the properties of the factory's import-options object (FbxImportUI and friends). Padrão true. |
Retorna: format, factory, supportedClass, options, factories.
import.get_source_files (risco 0, smoke)
Source files recorded on an asset, and which of them are missing on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Retorna: asset, files, missing, hasImportData.
import.gltf (risco 2, altera)
Imports a glTF/GLB file with whichever glTF importer this engine has (Interchange on 5.x, the glTF plugin on 4.27). Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute path of the file to import. |
folder | string | obrigatório. Destination content folder. |
name | string | Asset name; empty uses the file name. |
factory | string | Factory class name; empty picks the factory that claims the extension. |
options | array of UeaKeyValue | Factory (or import-options) properties as text; use import.get_options to discover them. |
replaceExisting | boolean | Padrão true. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.interchange_info (risco 0, UE 5.1+, smoke)
Whether the Interchange import framework is available and enabled, and which Interchange plugins are on.
Sem argumentos.
Retorna: available, importEnabled, plugins, message.
import.json_to_data_table (risco 2, altera)
Creates a DataTable from a JSON file and a row struct. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute .csv / .json path. |
rowStruct | string | obrigatório. Row struct: a native struct name or a user defined struct asset path. |
folder | string | obrigatório. |
name | string | obrigatório. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.list_exporters (risco 0, smoke)
Exporters registered in the editor, optionally for one asset class.
| Argumento | Tipo | Descrição |
|---|---|---|
class | string | Optional class filter, e.g. "StaticMesh". Empty lists every exporter. |
Retorna: exporters, total.
import.list_formats (risco 0, smoke)
File extensions the installed importers understand, with the factory handling each.
Sem argumentos.
Retorna: formats.
import.list_importable_extensions (risco 0, smoke)
File extensions the installed factories can import, with the factory and asset class of each.
Sem argumentos.
Retorna: extensions, total.
import.reimport (risco 3, altera)
Reimports an asset from its recorded source file (or a new file). Not smoke-tested: needs an imported asset with a source file.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | Optional new source file. |
Retorna: asset.
import.reimport_folder (risco 3, altera, dryRun, smoke)
Reimports every asset of a folder that has a source file. Run with dryRun first.
| Argumento | Tipo | Descrição |
|---|---|---|
folder | string | obrigatório. |
classFilter | string | Optional class filter, e.g. "Texture2D". |
recursive | boolean | Padrão true. |
dryRun | boolean | Only list what would be reimported. Padrão false. |
limit | integer | Padrão 100. |
Retorna: results, assets, succeededCount, failedCount, log.
import.reimport_many (risco 3, altera)
Reimports assets from their recorded source files. Not smoke-tested: needs imported assets with source files.
| Argumento | Tipo | Descrição |
|---|---|---|
assets | array of string | obrigatório. |
askForNewFiles | boolean | Open a file dialog when the recorded source file is missing (normally off for automation). Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.set_source_file (risco 2, altera)
Points an asset at a different source file without reimporting it. Not smoke-tested: needs an imported asset.
| Argumento | Tipo | Descrição |
|---|---|---|
asset | string | obrigatório. |
file | string | obrigatório. New absolute source file path. |
index | integer | Index of the source file slot to set (0 = the main one). Padrão 0. |
Retorna: asset, files, missing, hasImportData.
import.skeletal_mesh (risco 2, altera)
Imports a skeletal mesh from FBX (creates or reuses a skeleton, optional physics asset). Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
skeleton | string | Existing skeleton to bind to; empty creates a new one. |
importScale | number | Padrão 1.0. |
createPhysicsAsset | boolean | Padrão true. |
importMorphTargets | boolean | Padrão true. |
importMaterials | boolean | Padrão true. |
importAnimations | boolean | Padrão false. |
save | boolean | Padrão false. |
Retorna: assets, total.
import.sound (risco 2, altera)
Imports a sound wave (WAV/OGG/FLAC). Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute path of a file on disk (FBX, PNG, WAV, ...). |
folder | string | obrigatório. Destination content folder. |
name | string | Optional asset name; defaults to the file name. |
Retorna: assets, total.
import.static_mesh (risco 2, altera)
Imports a static mesh from FBX/OBJ with scale, combine, collision and material options. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
importScale | number | Padrão 1.0. |
combineMeshes | boolean | Merge every mesh in the file into one asset. Padrão true. |
generateCollision | boolean | Padrão true. |
generateLightmapUVs | boolean | Padrão true. |
importMaterials | boolean | Padrão true. |
importTextures | boolean | Padrão true. |
save | boolean | Padrão false. |
Retorna: assets, total.
import.texture (risco 2, altera)
Imports a texture (PNG/TGA/JPG/EXR/...) with sRGB, compression, group and mip settings. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
srgb | integer | -1 keeps the importer default, 0 = linear, 1 = sRGB. Padrão -1. |
compression | string | Compression setting name, e.g. "TC_Default", "TC_Normalmap", "TC_Masks", "TC_Grayscale", "TC_HDR". |
lodGroup | string | Texture group, e.g. "TEXTUREGROUP_World", "TEXTUREGROUP_UI". |
mipGen | string | Mip generation, e.g. "TMGS_NoMipmaps", "TMGS_FromTextureGroup". |
save | boolean | Padrão false. |
Retorna: asset, factory, saved, notes.
import.texture_with_settings (risco 2, altera)
Imports a texture with compression, sRGB, mip, group, size and green-channel settings. Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. |
folder | string | obrigatório. |
name | string | |
compression | string | e.g. "TC_Default", "TC_Normalmap", "TC_Masks". |
srgb | integer | -1 keeps the importer default, 0 = linear, 1 = sRGB. Padrão -1. |
mipGen | string | e.g. "TMGS_NoMipmaps", "TMGS_FromTextureGroup". |
lodGroup | string | e.g. "TEXTUREGROUP_World", "TEXTUREGROUP_UI". |
maxSize | integer | 0 keeps the source size; otherwise the maximum size in pixels. Padrão 0. |
flipGreen | boolean | Flip the green channel (DirectX to OpenGL normal maps). Padrão false. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.
import.with_options (risco 2, altera)
Imports one file with a factory configured from options[] (see import.get_options). Not smoke-tested: needs a source file on disk.
| Argumento | Tipo | Descrição |
|---|---|---|
file | string | obrigatório. Absolute path of the file to import. |
folder | string | obrigatório. Destination content folder. |
name | string | Asset name; empty uses the file name. |
factory | string | Factory class name; empty picks the factory that claims the extension. |
options | array of UeaKeyValue | Factory (or import-options) properties as text; use import.get_options to discover them. |
replaceExisting | boolean | Padrão true. |
save | boolean | Padrão false. |
Retorna: results, assets, succeededCount, failedCount, log.