Navigation
API > API/Plugins > API/Plugins/PythonScriptPlugin
Interface to pip installer used by python script plugin for installing plugin python dependencies
| Name | IPipInstall |
| Type | class |
| Header File | /Engine/Plugins/Experimental/PythonScriptPlugin/Source/PythonScriptPlugin/Public/IPipInstall.h |
| Include Path | #include "IPipInstall.h" |
Syntax
class IPipInstall
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPipInstall() |
IPipInstall.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumPackagesToInstall() |
Get number of missing python packages to install. | IPipInstall.h | |
| Get list of python packages to install. | IPipInstall.h | ||
bool InitPipInstall() |
Initialize the internal pip virtual env and check enabled plugins for python dependencies. | IPipInstall.h | |
bool IsInstalling() |
Check if a background install is running. | IPipInstall.h | |
bool LaunchPipInstall
(
bool RunAsync, |
Run pip to install all missing python dependencies for enabled plugins. | IPipInstall.h | |
bool RegisterPipSitePackagesPath() |
Register the site-packages path with embedded python env. | IPipInstall.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPipInstall & Get() |
IPipInstall.h |