Skip to content

Class RewriteReport

Namespace: Apogee.Content.Assets
Assembly: Apogee.Content.dll

What did, or in a preview would do.

public sealed record RewriteReport : IEquatable<RewriteReport>

Inheritance

object ← RewriteReport

Implements

IEquatable<RewriteReport>

Inherited Members

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

Constructors

RewriteReport(IReadOnlyList<ReferenceChange>, IReadOnlyList<AssetReferenceSite>, IReadOnlyList<AssetReferenceSite>, IReadOnlyList<AssetReferenceSite>, IReadOnlyList<SkippedDocument>, IReadOnlyList<string>, bool)

What did, or in a preview would do.

public RewriteReport(IReadOnlyList<ReferenceChange> Changes, IReadOnlyList<AssetReferenceSite> Unchanged, IReadOnlyList<AssetReferenceSite> ScriptMentions, IReadOnlyList<AssetReferenceSite> Unrewritable, IReadOnlyList<SkippedDocument> Skipped, IReadOnlyList<string> Documents, bool Applied)

Parameters

Changes IReadOnlyList<ReferenceChange>

The attributes that are rewritten to the new path (a reference that carries a UID keeps it).

Unchanged IReadOnlyList<AssetReferenceSite>

References to the asset that need no change: a uid:// alone follows the file by itself, and a reference that already says the new path.

ScriptMentions IReadOnlyList<AssetReferenceSite>

Script strings that mention the asset (a path, or its UID). They are reported and never rewritten: a script is code, and a string in it may be built or compared.

Unrewritable IReadOnlyList<AssetReferenceSite>

Other places that name the old path and are not rewritten, for the editor to show: the paths in game.xml (<EntryScene>, <Icon>) and mod.xml (<Script>), whose is the full path they name, and text inside an element of a document ( is empty). They break if the file moves and nothing here fixes them.

Skipped IReadOnlyList<SkippedDocument>

The documents that were not used, each with the reason. A document in a read-only root that refers to the asset is here: its references were found and not rewritten. A file that is not well-formed is here too; it may or may not have held references.

Documents IReadOnlyList<string>

The files that were changed (in a preview, that would be).

Applied bool

False for a preview: nothing was written.

Properties

Applied

False for a preview: nothing was written.

public bool Applied { get; init; }

Property Value

bool

Changes

The attributes that are rewritten to the new path (a reference that carries a UID keeps it).

public IReadOnlyList<ReferenceChange> Changes { get; init; }

Property Value

IReadOnlyList<ReferenceChange>

Documents

The files that were changed (in a preview, that would be).

public IReadOnlyList<string> Documents { get; init; }

Property Value

IReadOnlyList<string>

ScriptMentions

Script strings that mention the asset (a path, or its UID). They are reported and never rewritten: a script is code, and a string in it may be built or compared.

public IReadOnlyList<AssetReferenceSite> ScriptMentions { get; init; }

Property Value

IReadOnlyList<AssetReferenceSite>

Skipped

The documents that were not used, each with the reason. A document in a read-only root that refers to the asset is here: its references were found and not rewritten. A file that is not well-formed is here too; it may or may not have held references.

public IReadOnlyList<SkippedDocument> Skipped { get; init; }

Property Value

IReadOnlyList<SkippedDocument>

Unchanged

References to the asset that need no change: a uid:// alone follows the file by itself, and a reference that already says the new path.

public IReadOnlyList<AssetReferenceSite> Unchanged { get; init; }

Property Value

IReadOnlyList<AssetReferenceSite>

Unrewritable

Other places that name the old path and are not rewritten, for the editor to show: the paths in game.xml (<EntryScene>, <Icon>) and mod.xml (<Script>), whose is the full path they name, and text inside an element of a document ( is empty). They break if the file moves and nothing here fixes them.

public IReadOnlyList<AssetReferenceSite> Unrewritable { get; init; }

Property Value

IReadOnlyList<AssetReferenceSite>