Class PackRequest¶
Namespace: Apogee.Content.Packs
Assembly: Apogee.Content.dll
What
public sealed record PackRequest : IEquatable<PackRequest>
Inheritance¶
Implements¶
Inherited Members¶
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Properties¶
AllowNothingImported¶
With imported/index.xml) is packed with nothing dropped, instead of being an error. An export sets
this, since a game of scripts and data has nothing to import.
public bool AllowNothingImported { get; init; }
Property Value¶
Bases¶
Makes a patch pack: these packs (in order, with the same
public IReadOnlyList<string> Bases { get; init; }
Property Value¶
CompressionLevel¶
The zstd level, 1 (fast) to 22 (small).
public int CompressionLevel { get; init; }
Property Value¶
Cooked¶
Pack what a shipped game needs: the imported artifacts instead of the sources, their settings and the files they were made from, and authored documents (imported/assets.xml in their cooked form (.xml files) in the content folders
of the base packages (packages/<id>/, as their mod.xml lists them). The manifests (mod.xml), schemas and sidecars stay text. It needs the folder to have been imported (imported/index.xml,
see dev_mods/ is cooked.
public bool Cooked { get; init; }
Property Value¶
Exclude¶
Folder-relative prefixes of what to leave out, compared as plain text and case-sensitively (dev_mods/ leaves out that folder; dev_mods would also leave out dev_mods2/). Both
slashes work. They are applied to the files in the folder, so a patch pack with a prefix also removes what an earlier pack held under it.
public IReadOnlyList<string> Exclude { get; init; }
Property Value¶
Folder¶
The game folder: it is res://, and the paths in the pack are relative to it. Names that start with a dot are left out.
public required string Folder { get; init; }
Property Value¶
Key¶
Encrypts the pack (
public PackKey? Key { get; init; }
Property Value¶
Output¶
The first part of the pack (game.pack); a bigger pack goes on in game_001.pack… beside it.
public required string Output { get; init; }
Property Value¶
SplitBytes¶
A part grows to about this many bytes before the next file starts a new one.
public long SplitBytes { get; init; }