Nuke.Unreal.Platforms.Linux.WindowsHostsLinux Class Reference

Inheritance diagram for Nuke.Unreal.Platforms.Linux.WindowsHostsLinux:

Public Member Functions
async Task	Setup (IUnrealBuild build)
bool	IsValid (IUnrealBuild build)
	Would this SDK be ever valid for the given Unreal project. This check is done before Setup is called. It shouldn't yet check if SDK is available locally, only that it can be made available at some point in the future. For checking if an installed SDK is available locally use Exists
AbsolutePath	GetSdkPath (IUnrealBuild build)
	The root of the currently used platform SDK in the file system, if there's one.
AbsolutePath	GetToolchainPath (IUnrealBuild build)
	Get the path to a C++ toolchain folder which may be used to compile external C++ code with to maintain ABI compatibility if that code needs to link with Unreal.
PlatformSdkXMakeData	GetXMakeData (IUnrealBuild build)
	If applicable and XMake can work with the toolchains provided by this SDK, return information for it how to do so.
Public Member Functions inherited from Nuke.Unreal.Platforms.IPlatformSdk
AbsolutePath	GetSdkVersionsPath (IUnrealBuild build)
	A shared user folder for this SDK version, owned by Nuke.Unreal. This may be a parent folder to store all the separate SDK versions. To get the path directly to the currently used SDK use GetSdkPath
bool	Exists (IUnrealBuild build)
	Whether a valid platform SDK exists locally for given project, and is ready to use without further downloading and installation.

Static Public Member Functions
static ? string	GetEpicToolchainName (IUnrealBuild build)

Properties
IPlatformSdk	SelfPlatformSdk [get]
UnrealPlatform	Host [get]
	The platform used for development, hosting this SDK to cross-compile target platform.
UnrealPlatform	Target [get]
	The platform targeted by given SDK.
Properties inherited from Nuke.Unreal.Platforms.IPlatformSdk

Static Private Member Functions
static ? string	GetEpicToolchainName (string unrealVersion)

Detailed Description

Definition at line 11 of file WindowsHostsLinux.cs.

Member Function Documentation

GetSdkPath()

AbsolutePath Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.GetSdkPath

(

IUnrealBuild

build

)

The root of the currently used platform SDK in the file system, if there's one.

Implements Nuke.Unreal.Platforms.IPlatformSdk.

GetToolchainPath()

AbsolutePath Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.GetToolchainPath

(

IUnrealBuild

build

)

Get the path to a C++ toolchain folder which may be used to compile external C++ code with to maintain ABI compatibility if that code needs to link with Unreal.

Implements Nuke.Unreal.Platforms.IPlatformSdk.

GetXMakeData()

PlatformSdkXMakeData Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.GetXMakeData

(

IUnrealBuild

build

)

If applicable and XMake can work with the toolchains provided by this SDK, return information for it how to do so.

Parameters

build

Returns

Implements Nuke.Unreal.Platforms.IPlatformSdk.

IsValid()

bool Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.IsValid

(

IUnrealBuild

build

)

Would this SDK be ever valid for the given Unreal project. This check is done before Setup is called. It shouldn't yet check if SDK is available locally, only that it can be made available at some point in the future. For checking if an installed SDK is available locally use Exists

Implements Nuke.Unreal.Platforms.IPlatformSdk.

Setup()

async Task Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.Setup

(

IUnrealBuild

build

)

Initial setup done when the SDK is first needed by a task in Nuke.Unreal. Download and install SDK files here and point Unreal to it via setting process environment variables for example. Even if an SDK is already downloaded and installed this Setup function would still need to connect Unreal to that.

This method can be called multiple times, not only at initialization. Implementations should tread accordingly.

Parameters

build

Current Unreal project, set or get data from it, as that's necessary for this platform SDK

Returns

As this can be a long-running process, implementation is recommended to be async

Implements Nuke.Unreal.Platforms.IPlatformSdk.

Definition at line 33 of file WindowsHostsLinux.cs.

Property Documentation

Host

UnrealPlatform Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.Host

get

The platform used for development, hosting this SDK to cross-compile target platform.

Implements Nuke.Unreal.Platforms.IPlatformSdk.

Definition at line 14 of file WindowsHostsLinux.cs.

SelfPlatformSdk

IPlatformSdk Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.SelfPlatformSdk

getprivate

Definition at line 13 of file WindowsHostsLinux.cs.

Target

UnrealPlatform Nuke.Unreal.Platforms.Linux.WindowsHostsLinux.Target

get

The platform targeted by given SDK.

Implements Nuke.Unreal.Platforms.IPlatformSdk.

Definition at line 15 of file WindowsHostsLinux.cs.

---

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

• /home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Platforms/Linux/WindowsHostsLinux.cs