Skip to content

Class ExportLayout

Namespace: Apogee.Export
Assembly: Apogee.Export.dll

Where the parts of an export go in the output folder. Windows and Linux: everything in the output folder (the executable, its libraries, game.xml and data/). macOS: a bundle, Name.app, with the program and its libraries in Contents/MacOS (the runtime's folder) and the game's own files in Contents/Resources.

public sealed class ExportLayout

Inheritance

object ← ExportLayout

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

Bundle

The .app folder on macOS; null elsewhere.

public string? Bundle { get; }

Property Value

string?

ExecutableDirectory

The folder with the executable and the native libraries (and Shaders).

public string ExecutableDirectory { get; }

Property Value

string

ExecutablePath

The executable: <out>/<exe>.exe on Windows, <out>/<exe> on Linux, <out>/<Name>.app/Contents/MacOS/<exe> on macOS.

public string ExecutablePath { get; }

Property Value

string

GameRoot

The folder with game.xml and data/: where the runtime looks for the game (see GameLocator).

public string GameRoot { get; }

Property Value

string

Output

The output folder the export was asked for.

public string Output { get; }

Property Value

string

PackPath

The first part of the game's pack: <game root>/data/game.pack.

public string PackPath { get; }

Property Value

string

Target

The platform the layout is for.

public ExportTarget Target { get; }

Property Value

ExportTarget

Methods

For(ExportTarget, GameManifest, string)

The layout of the export of manifest into output for target.

public static ExportLayout For(ExportTarget target, GameManifest manifest, string output)

Parameters

target ExportTarget

manifest GameManifest

output string

Returns

ExportLayout