Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig Class Reference

Identifies plugins with python requirements and attempts to install all dependencies using pip. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig:

Public Member Functions
virtual PipInstallConfig	PythonInterpreter (object val=null)
	Full path to python interpreter engine was built with (if unspecified use value in PythonSDKRoot.txt) Full path to python interpreter to use in case the engine is built against an external python SDK.
virtual PipInstallConfig	PipAction (PipAction? val=null)
	The action the pip install tool should implement (GenRequirements, Setup, Parse, Install, ViewLicenses, default: Install) Pip action: [GenRequirements, Setup, Parse, Install, ViewLicenses, default: Install].
virtual PipInstallConfig	IgnoreHashes (bool? val=null)
	Disable requiring hashes in pip install requirements (NOTE: this is insecure and may simplify supply-chain attacks) Do not require package hashes (WARNING: Enabling this flag is security risk)
virtual PipInstallConfig	OverrideIndexUrl (object val=null)
	Allow overriding the index url (this will also disable extra-urls) Use the specified index-url (WARNING: Should not be combined with IgnoreHashes)
virtual PipInstallConfig	AllPlugins (bool? val=null)
	Run pip installer on all plugins in project and engine.
Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void	AppendArgument (UnrealToolArgument arg)
virtual void	AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)
virtual void	AppendSubtool (ToolConfig subtool)
virtual string	Gather (EngineVersion ueVersion)
	Gether the arguments and subtools and render a command line output.

Properties
override string	Name [get]
override string	CliName [get]
override UnrealCompatibility	Compatibility [get]
override ToolConfig[]	Configs [get]
Properties inherited from Nuke.Unreal.Tools.ToolConfig
string	Name [get]
	The C# friendly name of the tool which will be used inside configurators.
string	CliName [get]
	The name which will be rendered onto command line.
UnrealCompatibility	Compatibility [get]
	Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.
virtual ToolConfig[]	Configs [get]

Private Attributes
ToolConfig[]	_configs = null

Additional Inherited Members
Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgument >	UsingArguments = []
readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Detailed Description

Identifies plugins with python requirements and attempts to install all dependencies using pip.

Definition at line 20655 of file UbtConfigGenerated.cs.

Member Function Documentation

AllPlugins()

virtual PipInstallConfig Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.AllPlugins ( bool? val = null )

virtual

Run pip installer on all plugins in project and engine.

Definition at line 20744 of file UbtConfigGenerated.cs.

IgnoreHashes()

virtual PipInstallConfig Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.IgnoreHashes ( bool? val = null )

virtual

Disable requiring hashes in pip install requirements (NOTE: this is insecure and may simplify supply-chain attacks) Do not require package hashes (WARNING: Enabling this flag is security risk)

Definition at line 20703 of file UbtConfigGenerated.cs.

OverrideIndexUrl()

virtual PipInstallConfig Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.OverrideIndexUrl ( object val = null )

virtual

Allow overriding the index url (this will also disable extra-urls) Use the specified index-url (WARNING: Should not be combined with IgnoreHashes)

Definition at line 20723 of file UbtConfigGenerated.cs.

PipAction()

virtual PipInstallConfig Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.PipAction ( PipAction? val = null )

virtual

The action the pip install tool should implement (GenRequirements, Setup, Parse, Install, ViewLicenses, default: Install) Pip action: [GenRequirements, Setup, Parse, Install, ViewLicenses, default: Install].

Definition at line 20683 of file UbtConfigGenerated.cs.

PythonInterpreter()

virtual PipInstallConfig Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.PythonInterpreter ( object val = null )

virtual

Full path to python interpreter engine was built with (if unspecified use value in PythonSDKRoot.txt) Full path to python interpreter to use in case the engine is built against an external python SDK.

Definition at line 20663 of file UbtConfigGenerated.cs.

Member Data Documentation

_configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig._configs = null

private

Definition at line 20762 of file UbtConfigGenerated.cs.

Property Documentation

CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.CliName

get

Definition at line 20658 of file UbtConfigGenerated.cs.

Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.Compatibility

get

Definition at line 20659 of file UbtConfigGenerated.cs.

Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.Configs

getprotected

Definition at line 20763 of file UbtConfigGenerated.cs.

Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.PipInstallConfig.Name

get

Definition at line 20657 of file UbtConfigGenerated.cs.

---

The documentation for this class was generated from the following file:

• /home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs