Unreal Python API

Unreal Python API — Skill

Reference for the unreal Python module exposed by Unreal Engine's editor scripting plugin. Every page documents one unreal.<ClassName>: constructor signature, base class, C++ source module, editor properties, and method/property definitions.

Layout

• references/<ClassName>.md — one cleaned page per class (370 total)
• references/index.md — every class grouped by C++ source module (59 modules)
• references/unreal.md — module-level functions (load_asset, new_object, log, …)
• references/introduction.md — Epic's intro page
• references/_ObjectBase.md, _WrapperBase.md, _EnumEntry.md, _Logger.md — base classes

How to navigate

DO NOT Read references/index.md blindly — it's grep-friendly but ~600 lines. Filter to the section you need.

Filenames mirror class names exactly, so most lookups don't need the index at all.

1. Class by name (most common)

ls references/ | grep -i "staticmesh"
ls references/ | grep -iE "^(Actor|Pawn|Character)"

Then Read references/<ClassName>.md.

2. Symbol / method search across pages

grep -rli "spawn_actor" references/ | head
grep -rli "set_static_mesh" references/ | head

-l returns filenames only — open the most relevant.

3. Browse a module's classes

awk '/^## Engine$/{f=1; next} /^## /{f=0} f' references/index.md | head -40
awk '/^## AnimGraphRuntime$/{f=1; next} /^## /{f=0} f' references/index.md

List module names only:

grep -E "^- \*\*" references/index.md

4. Module-level functions

grep -i "load_asset\|new_object" references/unreal.md

Page format

Each cleaned class page has this shape:

# `unreal.ClassName`

_class_ unreal.ClassName(...constructor args...)

Bases: `unreal.ParentClass`

<one-line description>

**C++ Source:**
- **Module**: <ModuleName>
- **File**: <Header.h>

**Editor Properties:** (see get_editor_property/set_editor_property)
- `prop_name` (Type): [Read-Write] Description...

_property_ prop_name
[Read-Write] Description...
Type
(TypeName)

<...method definitions...>

The class signature, Bases:, and Module: lines are the most reliable anchors for grep.

Coverage notes

• Version: the bulk of pages are UE 4.27 — that's the version Epic still publishes the Python API reference under at dev.epicgames.com/.../python-api/. A few 5.1 / 5.3 pages are mixed in where Epic added version-specific entries.
• Native types (Array, Map, Set, Name, Text, etc.) have no C++ Module field and land in the Uncategorized group of references/index.md.
• Not included: the alphabetic genindex-* pages from the source site — they were just A-Z link tables. Use ls references/ | grep instead.
• Sibling skill: for full UE concept/tutorial docs (Blueprint, rendering, animation, etc.), see claude-skill-unreal-engine-full.

Lookup precedence

If the agent has both this skill and the broader UE skill loaded:

• Python script questions (unreal.X API, editor automation, asset Python) → this skill.
• Concept / tutorial / Blueprint / C++ questions → unreal-engine skill.