Nuke.Unreal.BuildCommon Class Reference

Extra build related utilities not necessarily associated with Unreal tasks. More...

Static Public Member Functions
static AbsolutePath	GetContentsFolder ()
	Get the contents folder Nuke.Unreal is shipped with. This is usually contained in the local nuget installation of Nuke.Unreal, but may vary depending on the circumstances.
static bool	IsProjectFolder (this AbsolutePath path)
	Returns false on known folders which are intermediate results of Engine operations, therefore its contents must not be modified by the user.
static IEnumerable< AbsolutePath >	SubTreeProject (this AbsolutePath origin, Func< AbsolutePath, bool >? filter=null)
	Gives a recursive folder tree filtering out known intermediate folders.
static bool	LookAroundFor (Func< string, bool > predicate, out AbsolutePath? result)
	Look for something in subtree of a folder or in parent folders based on a predicate.
static ? AbsolutePath	GetOwner (this AbsolutePath path, string ownerPattern)
	Get the owning parent folder of an arbitrarily deep subfolder based on wildcard filtering of files in parent folder. The closest match will be returned.
static ? AbsolutePath	GetOwningPlugin (this AbsolutePath path)
	Get the Unreal plugin owning the given subfolder.
static ? AbsolutePath	GetOwningProject (this AbsolutePath path)
	Get the Unreal project owning the given subfolder.
static ? AbsolutePath	GetOwningModule (this AbsolutePath path)
	Get the Unreal module owning the given subfolder.
static AbsolutePath	Shorten (this AbsolutePath longPath, bool allPlatforms=false)
	Create a short path symlink for input path to work around the 260 character path length limitation cursing Windows from the 80's to present day.

Detailed Description

Extra build related utilities not necessarily associated with Unreal tasks.

Definition at line 22 of file BuildCommon.cs.

Member Function Documentation

GetContentsFolder()

static AbsolutePath Nuke.Unreal.BuildCommon.GetContentsFolder ( )

static

Get the contents folder Nuke.Unreal is shipped with. This is usually contained in the local nuget installation of Nuke.Unreal, but may vary depending on the circumstances.

Definition at line 28 of file BuildCommon.cs.

GetOwner()

static ? AbsolutePath Nuke.Unreal.BuildCommon.GetOwner ( this AbsolutePath path, string ownerPattern )

static

Get the owning parent folder of an arbitrarily deep subfolder based on wildcard filtering of files in parent folder. The closest match will be returned.

Parameters

path
ownerPattern

Returns

Owning parent folder or null if there's no match.

GetOwningModule()

static ? AbsolutePath Nuke.Unreal.BuildCommon.GetOwningModule ( this AbsolutePath path )

static

Get the Unreal module owning the given subfolder.

GetOwningPlugin()

static ? AbsolutePath Nuke.Unreal.BuildCommon.GetOwningPlugin ( this AbsolutePath path )

static

Get the Unreal plugin owning the given subfolder.

GetOwningProject()

static ? AbsolutePath Nuke.Unreal.BuildCommon.GetOwningProject ( this AbsolutePath path )

static

Get the Unreal project owning the given subfolder.

IsProjectFolder()

static bool Nuke.Unreal.BuildCommon.IsProjectFolder ( this AbsolutePath path )

static

Returns false on known folders which are intermediate results of Engine operations, therefore its contents must not be modified by the user.

Parameters

path

Returns

LookAroundFor()

static bool Nuke.Unreal.BuildCommon.LookAroundFor ( Func< string, bool > predicate, out AbsolutePath? result )

static

Look for something in subtree of a folder or in parent folders based on a predicate.

Shorten()

static AbsolutePath Nuke.Unreal.BuildCommon.Shorten ( this AbsolutePath longPath, bool allPlatforms = false )

static

Create a short path symlink for input path to work around the 260 character path length limitation cursing Windows from the 80's to present day.

Definition at line 123 of file BuildCommon.cs.

SubTreeProject()

static IEnumerable< AbsolutePath > Nuke.Unreal.BuildCommon.SubTreeProject ( this AbsolutePath origin, Func< AbsolutePath, bool >? filter = null )

static

Gives a recursive folder tree filtering out known intermediate folders.

Parameters

origin
filter	Extra filtering function

---

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

• /home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/BuildCommon.cs