Use when automating Unreal Engine editor tasks via REST API, manipulating actors/materials/blueprints, working with the UnrealBridgeREST plugin, or executing Python in UE.
95% Confidence Rule: Never suggest an API without verifying it exists in the Python stub file or REST schema.
Asset Safety: Never use os.rename(), shutil.move() on .uasset files. Use unreal.EditorAssetLibrary instead.
AskUserQuestion({
questions: [{
question: "What do you want to do in Unreal Engine?",
header: "Task",
multiSelect: false,
options: [
{ label: "Actors", description: "Spawn, transform, modify properties, destroy" },
{ label: "Materials", description: "Create, edit graph, set parameters" },
{ label: "Blueprints/Assets", description: "Nodes, connections, list, search, export" },
{ label: "Setup/Python", description: "Install plugin, execute custom Python" }
]
}]
})
Wait for user selection before proceeding.
After reading reference, follow it exactly.
Example - Spawn actor:
curl -s -X POST "http://localhost:$PORT/api/v1/actors/spawn" \
-H "Content-Type: application/json" \
-d '{"class": "/Script/Engine.StaticMeshActor", "label": "Cube1"}'
Example - Create material:
curl -s -X POST "http://localhost:$PORT/api/v1/materials/create" \
-H "Content-Type: application/json" \
-d '{"name": "M_MyMaterial", "path": "/Game/Materials"}'
Discover endpoints:
curl -s "http://localhost:$PORT/api/v1/schema"
curl -s "http://localhost:$PORT/api/v1/schema?handler=materials"
Python Stub: {ProjectDir}/Intermediate/PythonStub/unreal.py - Search here FIRST before suggesting Python APIs. If not in stub, it's NOT available.
ALWAYS:
unreal.EditorAssetLibrary for asset operations| Handler | File | Key Operations |
|---|---|---|
| actors | endpoints/actors.md | spawn, transform, properties, destroy |
| materials | endpoints/materials.md | create, graph edit, connect, export/import XML |
| blueprints | endpoints/blueprints.md | nodes, connections, compile, variables |
| assets | endpoints/assets.md | list, search, info, refs, export |
| editor | endpoints/editor.md | camera, selection, live coding |
| level | endpoints/level.md | info, outliner |
| python | endpoints/python.md | execute, async, status |
| infrastructure | endpoints/infrastructure.md | health, schema, batch |
Guides:
| Guide | Purpose |
|---|---|
| api_overview.md | Handler index, discovery flow |
| decision_trees.md | REST vs Python decision |
| batch_patterns.md | Multi-operation examples |
| python_fallback.md | Python patterns, threading |
| setup.md | Plugin installation |
| execution_methods.md | REST vs Commandlet |
| best_practices.md | Verified UE Python patterns |
| common_apis.md | Tested API reference |