Unreal Python Recipe Book
  • About
  • Getting Started
  • Dev Conveniences
    • Python Command Line
    • Modifier Keys (alt, ctrl shift)
    • Convenience Modules
    • Abstraction Layer
  • Assets
    • Loading Assets
    • New Asset Instances
    • Getting the Default Object
    • Get / Set Editor Properties
    • Calling BP Graph Functions
    • Asset Path ↔ File Path
    • Python Module Example
  • Actors
    • Get Asset from Actor
      • [c++] Get Asset List For Actor
    • Spawning Actors
    • Get All Actors in 3D Level
    • Walking The Actor Hierarchy
    • Walking Components
    • On Selection Changed Callback
    • Python Module Example
  • Metadata
    • Epic Documentation
    • [c++] Registering Metadata Tags
    • Setting Metadata
    • Getting Metadata
    • Find Assets By Metadata
    • Python Module Example
  • Calling Python From Blueprint
    • The Execute Python Script Node
    • Blueprint Function Libraries
      • Python Module Example
      • Making BP Function Libraries Safer
    • Subsystems (Don't Use)
  • Editor Menus
    • Discovering Menus to Extend
    • Getting a Reference to a Menu
    • Adding a Drop Down Menu
    • Python Menu Class
      • Insert Position
      • Menu Icons
      • Toggled Menu Entries
      • Editor Utility Widget Launcher
    • Python Module Example
  • Startup & Shutdown Scripts
    • Treat init_unreal like __init__
    • Startup Script Management
    • Shutdown Script Management
    • Python Module Example
  • Using Engine-Version Specific Code
  • UE5 Demo Plugin (GitHub)
Powered by GitBook
On this page
  • Overview
  • Intended Audience
  • Sample Plugin + Original Documentation
  • About the Author

About

Last updated 1 month ago

This project explores the use of Python in Unreal Engine 5, helping to showcase what's possible with Python in Unreal as well as how to use it.

Overview

This project is meant to supplement the official Epic documentation on Python and is unaffiliated with Epic or any other company. This project is written and maintained by Brian Kortbus. This project is meant to provide examples of how Unreal's systems can be used via Python and explore what's possible. This project is considered incomplete, new pages and revisions will be added as time allows.

I mostly used Unreal Engine 5.2 and 5.3 for this project, although most code is relevant in newer versions as Epic seldom removes features. If a feature is specific to a newer version of Unreal I'll make great effort to call that out.

Intended Audience

This project is intended for readers who are already reasonably confident and comfortable in both Python and Unreal. The focus of this project is to show how the Unreal Python API can be used.

Sample Plugin + Original Documentation

A sample UE Plugin is available on my Github at:

This Github Project contains a Plugin with examples of the code shown throughout this Documentation as well as the original version of the Recipe Book documentation.

About the Author

Howdy! My name is Brian Kortbus, I am a developer with a professional background in both Animated Film as well as Video Games. I've been pretty excited about the exploration and use of Unreal for Film in recent years, both in seeing how its use has evolved and experiencing firsthand how much more capable Unreal has become for non-c++ developers since I transitioned from video games to film. I hope this project helps others in exploring what can be done wiht Python in Unreal!

Page cover image
https://github.com/bralkor/unreal_python_recipe_book