Skip to content

Class GamePacker

Namespace: Apogee.Content.Packs
Assembly: Apogee.Content.dll

Packs a game folder into a pack (see ): the library behind Apogee.Runtime --pack, and what an export calls. The sources of imported assets are dropped from a cooked pack, authored XML and the definitions of the base packages are cooked in place, and a patch pack holds only what changed against its bases.

public static class GamePacker

Inheritance

object ← GamePacker

Inherited Members

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

Methods

Pack(PackRequest)

Writes the pack.

public static PackReport Pack(PackRequest request)

Parameters

request PackRequest

Returns

PackReport

Exceptions

ContentException

The folder is not a folder; and nothing is imported; a path cannot be in a pack; an authored document is not well-formed.

IOException

Reading or writing failed.

ArgumentException

A base pack already has a part of the same path, an entry is empty, or the compression level is not 1 to 22.

PathsOf(PackRequest)

The folder-relative paths would put in the pack (a patch pack may hold fewer, since it leaves out what its bases have), in ordinal order: what is in the folder, less the names that start with a dot, , and when what the imported artifacts replace. A cooked document is at the same path as its source.

public static IReadOnlyList<string> PathsOf(PackRequest request)

Parameters

request PackRequest

Returns

IReadOnlyList<string>

Exceptions

ContentException

As for , except for the documents, which this does not read.