io kit

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

Tools

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

io.clear_pipeline_status (risk 2, mutates, smoke)

Clears only the retained pipeline status, leaving its ordered import steps unchanged.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.

Returns: pipeline, steps.

io.create_pipeline (risk 2, mutates, smoke)

Creates a pipeline DataAsset that stores ordered source-file import steps.

Argument	Type	Description
folder	string	required. Content folder for the pipeline DataAsset.
name	string	required. Bare pipeline asset name.
steps	array of UeaIeoPipelineStep	Ordered source-file steps; empty creates a reusable empty pipeline.

Returns: pipeline, steps.

io.duplicate_pipeline (risk 2, mutates, smoke)

Duplicates a persistent pipeline definition and retained history into a new DataAsset.

Argument	Type	Description
pipeline	string	required. Existing pipeline DataAsset path.
folder	string	required. Destination content folder beginning with /Game.
name	string	required. Bare destination asset name.

Returns: pipeline, steps.

io.export_pipeline (risk 3, mutates)

Exports each preflighted asset through Unreal's public exporter task API.

Argument	Type	Description
pipeline	string	required. Pipeline DataAsset path.
allowOverwrite	boolean	Required explicit consent before replacing any existing output file. Default false.

Returns: pipeline, steps, ready, succeededCount, failedCount.

io.get_pipeline (risk 0, smoke)

Returns a pipeline's stored steps and durable last-run summary.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.

Returns: pipeline, steps.

io.get_pipeline_history (risk 0, smoke)

Returns durable import and export run history retained by the pipeline asset.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.

Returns: pipeline, importErrors.

io.get_pipeline_status (risk 0, smoke)

Returns the status preserved by the most recent completed or blocked pipeline run.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.

Returns: pipeline, steps.

io.preflight_export_pipeline (risk 0, smoke)

Validates export assets, output folders, and overwrite permission without writing files.

Argument	Type	Description
pipeline	string	required. Pipeline DataAsset path.
checkExistingFiles	boolean	Check whether a destination output already exists. Default true.

Returns: pipeline, steps, ready, succeededCount, failedCount.

io.preflight_pipeline (risk 0, smoke)

Validates sources, destinations, factories, duplicate outputs and replacement permission without importing.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.
checkSourceFiles	boolean	Check each external source file before reporting readiness. Default true.

Returns: pipeline, steps, ready, errorCount, warningCount.

io.run_pipeline (risk 3, mutates)

Runs a fully preflighted pipeline and persists its per-step outcome. Not smoke-tested: it requires real external source files.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.
save	boolean	Save successfully imported assets to disk after each importer finishes. Default false.

Returns: pipeline, steps, succeededCount, failedCount.

io.set_export_steps (risk 2, mutates, smoke)

Replaces the pipeline's explicit asset-to-file export manifest without exporting files.

Argument	Type	Description
pipeline	string	required. Pipeline DataAsset path.
steps	array of UeaIeoExportStep	required. Complete replacement export manifest.

Returns: pipeline, steps.

io.set_pipeline_steps (risk 2, mutates, smoke)

Replaces every stored step after validating the safe pipeline shape.

Argument	Type	Description
pipeline	string	required. Import/export pipeline DataAsset path.
steps	array of UeaIeoPipelineStep	required. Complete replacement ordered step list.

Returns: pipeline, steps.