Skip to content

nils-soderman/vscode-unreal-python

Repository files navigation

Unreal Engine Python (Visual Studio Code)

Editor features to assist when writing Python code for Unreal Engine.


Features

Execute Code

Run code in Unreal Engine directly from within the editor:

execute code in unreal demo

Command: Unreal Python: Execute
Keyboard Shortcut: Ctrl + Enter

The selected text will be executed, or if nothing is selected the entire document will be executed.


Setup Code Completion

Setup code completion for the unreal module based on the current project.

code completion demo

Command: Unreal Python: Setup code completion


Debugging

Attach VS Code to Unreal Engine to debug your scripts, set breakpoints and step through the code.

debug unreal python scripts demo

Command: Unreal Python: Attach


Documentation

Browse the Unreal Engine Python documentation inside VS Code. This documentation is generated on the fly based on the currently opened Unreal Engine instance, therefore it will always be up to date & include any custom C++ functions/classes that you have exposed to Blueprint/Python.

browse Unreal Engine's Python Documentation in VS Code demo

Command: Unreal Python: Open Documentation


Notes:

  • Commands can be run from the command palette, Show All Commands (Default shortcut: Ctrl + Shift + P)
  • Remote Execution must be enabled in Unreal Engine for this extension to work, more details here.

Contact

If you have any questions, feature requests or run into any bugs, don't hesitate to get in contact with me:

Report an issue
Personal Website


* This is a third-party extension and is not associated with Unreal Engine or Epic Games in any way.