Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig Class Reference

Syncs and builds all the binaries required for a project. More...

Inheritance diagram for Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig:

Public Member Functions
virtual SyncProjectConfig	Project (params object[] values)
	Project to sync. Will search current path and paths in ueprojectdirs. If omitted will sync projectdirs.
virtual SyncProjectConfig	Threads (params object[] values)
	How many threads to use when syncing. Default=2. When >1 all output happens first.
virtual SyncProjectConfig	Cl (params object[] values)
	Changelist to sync to. If omitted will sync to latest CL of the workspace path. 0 Will Remove files!
virtual SyncProjectConfig	Clean (params object[] values)
	Clean old files before building.
virtual SyncProjectConfig	Build (params object[] values)
	Build after syncing.
virtual SyncProjectConfig	Open (params object[] values)
	Open project editor after syncing.
virtual SyncProjectConfig	Generate (params object[] values)
	Generate project files after syncing.
virtual SyncProjectConfig	Force (params object[] values)
	force sync files (files opened for edit will be untouched)
virtual SyncProjectConfig	Preview (params object[] values)
	Shows commands that will be executed but performs no operations.
virtual SyncProjectConfig	Projectonly (params object[] values)
	Only sync the project.
virtual SyncProjectConfig	Paths (params object[] values)
	Only sync this path. Can be comma-separated list.
virtual SyncProjectConfig	Retries (params object[] values)
	Number of retries for a timed out file. Defaults to 3.
virtual SyncProjectConfig	Unversioned (params object[] values)
	Do not set an engine version after syncing.
virtual SyncProjectConfig	Path (params object[] values)
	Only sync files that match this path. Can be comma-separated list.
virtual SyncProjectConfig	Deprecated (params object[] values)
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

Syncs and builds all the binaries required for a project.

WARNING: This command might require Perforce

Definition at line 23799 of file UatConfigGenerated.cs.

Member Function Documentation

Build()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Build ( params object[] values )

virtual

Build after syncing.

Definition at line 23882 of file UatConfigGenerated.cs.

Cl()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Cl ( params object[] values )

virtual

Changelist to sync to. If omitted will sync to latest CL of the workspace path. 0 Will Remove files!

Definition at line 23844 of file UatConfigGenerated.cs.

Clean()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Clean ( params object[] values )

virtual

Clean old files before building.

Definition at line 23863 of file UatConfigGenerated.cs.

Deprecated()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Deprecated ( params object[] values )

virtual

Definition at line 24072 of file UatConfigGenerated.cs.

Force()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Force ( params object[] values )

virtual

force sync files (files opened for edit will be untouched)

Definition at line 23939 of file UatConfigGenerated.cs.

Generate()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Generate ( params object[] values )

virtual

Generate project files after syncing.

Definition at line 23920 of file UatConfigGenerated.cs.

Open()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Open ( params object[] values )

virtual

Open project editor after syncing.

Definition at line 23901 of file UatConfigGenerated.cs.

Path()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Path ( params object[] values )

virtual

Only sync files that match this path. Can be comma-separated list.

Definition at line 24053 of file UatConfigGenerated.cs.

Paths()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Paths ( params object[] values )

virtual

Only sync this path. Can be comma-separated list.

Definition at line 23996 of file UatConfigGenerated.cs.

Preview()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Preview ( params object[] values )

virtual

Shows commands that will be executed but performs no operations.

Definition at line 23958 of file UatConfigGenerated.cs.

Project()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Project ( params object[] values )

virtual

Project to sync. Will search current path and paths in ueprojectdirs. If omitted will sync projectdirs.

Definition at line 23806 of file UatConfigGenerated.cs.

Projectonly()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Projectonly ( params object[] values )

virtual

Only sync the project.

Definition at line 23977 of file UatConfigGenerated.cs.

Retries()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Retries ( params object[] values )

virtual

Number of retries for a timed out file. Defaults to 3.

Definition at line 24015 of file UatConfigGenerated.cs.

Threads()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Threads ( params object[] values )

virtual

How many threads to use when syncing. Default=2. When >1 all output happens first.

Definition at line 23825 of file UatConfigGenerated.cs.

Unversioned()

virtual SyncProjectConfig Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Unversioned ( params object[] values )

virtual

Do not set an engine version after syncing.

Definition at line 24034 of file UatConfigGenerated.cs.

Member Data Documentation

_configs

ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig._configs = null

private

Definition at line 24090 of file UatConfigGenerated.cs.

Property Documentation

CliName

override string Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.CliName

get

Definition at line 23802 of file UatConfigGenerated.cs.

Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Compatibility

get

Definition at line 23803 of file UatConfigGenerated.cs.

Configs

override ToolConfig [] Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Configs

getprotected

Definition at line 24091 of file UatConfigGenerated.cs.

Name

override string Nuke.Unreal.Tools.UatConfigGenerated.SyncProjectConfig.Name

get

Definition at line 23801 of file UatConfigGenerated.cs.

---

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

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