Scripting API

Scripting API

AddOn

Record in Abyss.Core, from Abyss.Core.

A pack that does not ship with its game — an Addressables group built as an add-on, or one language's strings of the string tables in such a group — as the game's build lists it: its file, the length and SHA-256 a file downloaded or given is checked against before it is attached, and what it holds.

public record AddOn

Constructors

AddOn

public AddOn(string Name, string File, long Size, string Sha256)

A pack that does not ship with its game — an Addressables group built as an add-on, or one language's strings of the string tables in such a group — as the game's build lists it: its file, the length and SHA-256 a file downloaded or given is checked against before it is attached, and what it holds.

Parameters

  • Name: Its group, Level 2; for one language's strings, the group and the language, Dialogs (ru).
  • File: Its file's name on the player's computer: level2.abypack.
  • Size: Its file's length, in bytes.
  • Sha256: Its file's SHA-256, in lowercase hexadecimal.

Properties

Name

public string Name { get; init; }

Its group, Level 2; for one language's strings, the group and the language, Dialogs (ru).

File

public string File { get; init; }

Its file's name on the player's computer: level2.abypack.

Size

public long Size { get; init; }

Its file's length, in bytes.

Sha256

public string Sha256 { get; init; }

Its file's SHA-256, in lowercase hexadecimal.

Pack

public AssetGuid Pack { get; init; }

The identity its stamp gives the pack: the one build of it the list names.

Hosted

public string? Hosted { get; init; }

Its file's name where it is hosted, with its hash — level2_3f9a1c2bd4e5f607.abypack — or null where it is AddOn.File.

HostedFile

public string HostedFile { get; }

What it is downloaded as: AddOn.Hosted, or AddOn.File.

Language

public string? Language { get; init; }

The language whose strings it holds, ru, of its group's string tables; null for a group's own pack.

Group

public string Group { get; init; }

The Addressables group it was built from: its AddOn.Name, or, for one language's strings, the group whose tables they are.

Catalog

public AssetCatalog Catalog { get; init; }

What it holds that a game asks for: each addressable asset by path and identity, with its address and labels, so PackAccess.AddOnOf and a load needing it name the add-on before it is on the computer. What its assets need is not listed: only they reach it.

Methods

NameOf

public static string NameOf(string group, string language)

What a language's strings of a group's tables are called as an add-on: Dialogs (ru).

Parameters

  • group
  • language