Scripting API

Scripting API

AddOnDownload

Class in Abyss.Core, from Abyss.Core.

A download of an add-on from the game's content address into the player's folder (PackAccess.Download): how far it has got, read each frame, and awaited, which ends once it is attached, has failed or was cancelled. A group's add-on with string tables comes with its strings in the language in use, an add-on of their own: one download of both, its size and progress theirs together, attached once both are.

public sealed class AddOnDownload

Example

AddOnDownload bonus = flow.Packs.Download(addOn);bar.Value = bonus.Progress;if (await bonus == AddOnDownloadState.Attached) { ... }

Properties

AddOn

public AddOn AddOn { get; }

The add-on, as its list names it.

State

public AddOnDownloadState State { get; }

What it is doing: downloading while a part is, then checking.

Received

public long Received { get; }

How many of its bytes are on the computer, what an earlier download left included.

Size

public long Size { get; }

How many bytes it is, as its list says: with its strings, theirs too.

Progress

public float Progress { get; }

How far it has got, from 0 to 1.

Problem

public string? Problem { get; }

Why it failed; null while it has not.

IsDone

public bool IsDone { get; }

Whether it has ended: attached, failed or cancelled.

Ended

public Task<AddOnDownloadState> Ended { get; }

What it ends as, once it has.

Methods

Cancel

public void Cancel()

Stops it; what arrived is kept for the next download of the add-on to go on from.

GetAwaiter

public TaskAwaiter<AddOnDownloadState> GetAwaiter()

Waits for it to end, and gives what it ended as.