Scripting API

Scripting API

PlayerStart

Record in Abyss.Core, from Abyss.Core.

Where a game plays from, and what its build says of it: what Plan works out.

public record PlayerStart

Constructors

PlayerStart

public PlayerStart(string Home, string? Pack, BuildSettings Settings, PlayerSettings Player)

Where a game plays from, and what its build says of it: what Plan works out.

Parameters

  • Home: The folder beside the game: its executable's, or its build's output.
  • Pack: The pack it plays from, its whole path; null to play from the folders beside it.
  • Settings: What its build says: its scenes.
  • Player: What its Player says: its name, its window, its icon.

Properties

Home

public string Home { get; init; }

The folder beside the game: its executable's, or its build's output.

Pack

public string? Pack { get; init; }

The pack it plays from, its whole path; null to play from the folders beside it.

Settings

public BuildSettings Settings { get; init; }

What its build says: its scenes.

Player

public PlayerSettings Player { get; init; }

What its Player says: its name, its window, its icon.

More

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

Every other pack beside the main one, by its whole path, in order of their names: each group's a build made, and any added after it, mounted as the game starts over the main one.

Mix

public AudioMix Mix { get; init; }

Its mix: the buses its sounds play on, Master alone for a game that says nothing of them.

MixProblem

public string? MixProblem { get; init; }

Why its mix could not be read, which leaves it Master alone; null when it was.

Sorting

public SortingLayers Sorting { get; init; }

Its sorting layers: Default alone for a game that says nothing of them.

SortingProblem

public string? SortingProblem { get; init; }

Why its sorting layers could not be read, which leaves them Default alone; null when they were.

Input

public InputActions Input { get; init; }

Its input actions: InputActions.Default for a game that says nothing of them.

InputProblem

public string? InputProblem { get; init; }

Why its input actions could not be read, which leaves them the default ones; null when they were.

Ui

public UiSettings Ui { get; init; }

Its interface's theme and reference resolution: none, and 1920 by 1080, for a game that says nothing of them.

UiProblem

public string? UiProblem { get; init; }

Why its interface's settings could not be read, which leaves them the defaults; null when they were.

AddOns

public AddOnSettings AddOns { get; init; }

Where it downloads its add-ons from: nowhere, for a game that says nothing of it.

ContentAddress

public string? ContentAddress { get; init; }

The address it was told to download its add-ons from in place of its settings' — the command line's --content, as the editor's Build And Run gives it while its add-on server is on — or null.

AddOnsProblem

public string? AddOnsProblem { get; init; }

Why its Add-ons settings could not be read, which leaves it downloading nothing; null when they were.

Time

public TimeSettings Time { get; init; }

Its clock: sixty fixed steps a second, at the speed time passes, for a game that says nothing of it.

TimeProblem

public string? TimeProblem { get; init; }

Why its Time settings could not be read, which leaves them the defaults; null when they were.

Layers

public LayerSettings Layers { get; init; }

Its layers by name: Default alone for a game that names none.

LayersProblem

public string? LayersProblem { get; init; }

Why its layers could not be read, which leaves them Default alone; null when they were.