This repository provides Python stub files for various versions of Unreal Engine. These stubs enable code completion, static analysis, and improved development experience in IDEs like PyCharm, VS Code, and others that support Python type hints.
Unreal Engine's Python API is dynamically generated at runtime and not fully documented in a statically typed format. These stubs:
- Provide type hints and vanilla method signatures
- Improve auto-completion and linting
- Help with writing maintainable and IDE-friendly Python code for Unreal Engine projects
Inside each version folder you'll find:
unreal.py
| Unreal Version | Status |
|---|---|
| 4.27 | ✅ Available |
| 5.0 | ✅ Available |
| 5.1 | ✅ Available |
| 5.2 | ✅ Available |
| 5.3 | ✅ Available |
PRs for other versions or updated stubs are welcome!
- Clone this repo or download the relevant version folder:
git clone https://github.com/your-username/unreal-python-stubs.git
- In your Python environment, point your IDE's stub path or PYTHONPATH to the appropriate version folder: /path/to/unreal-python-stubs/5.2
🤝 Contributions
Contributions are welcome! Feel free to:
Submit stubs for missing versions
Update existing stubs with missing or corrected definitions
Report issues or suggest tools to improve stub generation