Skip to content

Class ExportOptions

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

What exports and how.

public sealed record ExportOptions : IEquatable<ExportOptions>

Inheritance

object ← ExportOptions

Implements

IEquatable<ExportOptions>

Inherited Members

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

Properties

Console

Windows only: keep the console subsystem, so that the game opens a console (to read its log).

public bool Console { get; init; }

Property Value

bool

Cooked

Pack the imported artifacts and cooked documents instead of the sources (the game is imported first, in a copy). Without it the pack holds the files as they are.

public bool Cooked { get; init; }

Property Value

bool

GameFolder

The game folder: the one with game.xml. It is only read, never written to.

public required string GameFolder { get; init; }

Property Value

string

Importers

The importers that import the game's assets when ; null: the content library's (models, images). The runtime also has the shader importer.

public IReadOnlyList<IAssetImporter>? Importers { get; init; }

Property Value

IReadOnlyList<IAssetImporter>?

Key

The key that encrypts the packs and is written into the executable (); null does neither.

public PackKey? Key { get; init; }

Property Value

PackKey?

OutputFolder

The folder the export goes into: it does not exist, is empty, or holds an earlier export (it has an .apogee-export file), which is then cleared.

public required string OutputFolder { get; init; }

Property Value

string

RuntimeDirectory

The folder of the published runtime for (--runtime); null looks for one, see .

public string? RuntimeDirectory { get; init; }

Property Value

string?

Target

The platform to export for.

public required ExportTarget Target { get; init; }

Property Value

ExportTarget