Documentation

3 tools. Back to the index.

create_asset_documentation

Additive.

Build a JSON record of one asset from the Asset Registry, without loading it or writing a file: identity, .uasset size and date, a coarse category and usage blurb, and depth-1 dependencies and referencers (100 each at most). Errors without an editor world.

Parameter	Type	Required	Description
asset_name	string	yes	Package path ("/Game/Props/SM_Chair") or object path ("/Game/Props/SM_Chair.SM_Chair") of the asset; a bare asset name is not resolved

Returns: { asset_documentation: { asset_name, asset_path, asset_class, asset_type, package_name, object_path, file_name, file_size: int (bytes, 0 if file_exists=false), last_modified: string, file_exists: bool, asset_category, usage, dependencies: [string] (package names, depth-1, capped at 100), dependencies_truncated: bool, dependents: [string] (referencers, depth-1, capped at 100), dependents_truncated: bool }, generation_date: string, project_name: string }

create_project_overview

Additive.

Create a comprehensive overview of the entire project including assets, actors, materials, and statistics.

No parameters.

Returns: { project_info: { project_name, engine_version, platform, generation_date, is_editor }, asset_types: [{ asset_type, count }], blueprint_info: { total_blueprints, normal_blueprints, macro_blueprints }, world_info: { world_name, net_mode, actor_count, level_count }, actor_types: [{ actor_type, count }], material_info: { total_materials }, texture_info: { total_textures }, audio_info: { total_audio_assets }, statistics: { total_assets, total_blueprints, total_materials, total_textures, total_audio_assets, total_actors } }

generate_blueprint_docs

Additive.

Generate documentation for all blueprints in the project (includes Blueprint, WidgetBlueprint, AnimBlueprint, and other Blueprint subclasses).

No parameters.

Returns: { blueprint_documentation: [{ blueprint_name, blueprint_path, blueprint_class, parent_class, blueprint_type, compilation_status, components, functions: [string], variables: [{name, type}] }], total_blueprints: int, generation_date: string, project_name: string }