Scripting API

Scripting API

PackageUpdate

Record in Abyss.Core, from Abyss.Core.

What changing a game's copy of a package to another version the registry has would do: each file it would change, what the copy has done to it, the files of the person's it leaves alone, and why it cannot be done or what it would break.

public record PackageUpdate

Constructors

PackageUpdate

public PackageUpdate(string Id, string From, string To, IReadOnlyList<UpdateFile> Files, IReadOnlyList<string> Kept, IReadOnlyList<string> Problems, IReadOnlyList<string> Warnings)

What changing a game's copy of a package to another version the registry has would do: each file it would change, what the copy has done to it, the files of the person's it leaves alone, and why it cannot be done or what it would break.

Parameters

  • Id: The package.
  • From: The version the game has.
  • To: The version it would have.
  • Files: Each file the version changes, by path.
  • Kept: Each file the person changed and the version did not, kept as it is.
  • Problems: Why it cannot be done: a package the version needs that the game has not at a version it takes.
  • Warnings: What it would break: a package needing this one at versions the new one is not, an engine it is not made for.

Properties

Id

public string Id { get; init; }

The package.

From

public string From { get; init; }

The version the game has.

To

public string To { get; init; }

The version it would have.

Files

public IReadOnlyList<UpdateFile> Files { get; init; }

Each file the version changes, by path.

Kept

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

Each file the person changed and the version did not, kept as it is.

Problems

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

Why it cannot be done: a package the version needs that the game has not at a version it takes.

Warnings

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

What it would break: a package needing this one at versions the new one is not, an engine it is not made for.