Scripting API

Scripting API

SettingsType

Record in Abyss.Core, from Abyss.Core.

A project's settings declared in code, described for an editor to show and a file to keep. See World.SettingsTypes.

public record SettingsType

Constructors

SettingsType

public SettingsType(string Title, string File, string Name, IReadOnlyList<ComponentField> Fields, IReadOnlyList<FieldHint> Hints, byte[] Start)

A project's settings declared in code, described for an editor to show and a file to keep. See World.SettingsTypes.

Parameters

  • Title: Its page's name in Project Settings.
  • File: Its file under settings, without .json.
  • Name: The struct's full name, as its component is registered.
  • Fields: Its fields, as its layout has them.
  • Hints: What its fields' attributes say of showing them.
  • Start: The bytes it starts as: its fields' initializers.

Properties

Title

public string Title { get; init; }

Its page's name in Project Settings.

File

public string File { get; init; }

Its file under settings, without .json.

Name

public string Name { get; init; }

The struct's full name, as its component is registered.

Fields

public IReadOnlyList<ComponentField> Fields { get; init; }

Its fields, as its layout has them.

Hints

public IReadOnlyList<FieldHint> Hints { get; init; }

What its fields' attributes say of showing them.

Start

public byte[] Start { get; init; }

The bytes it starts as: its fields' initializers.

PathName

public string PathName { get; }

Where a game keeps them, and its pack: settings/physics-2d.json.

Methods

FileIn

public string FileIn(string game)

Where the game at game keeps them.

Parameters

  • game