Scripting API

Scripting API

ControllerDocument

Class in Abyss.Core, from Abyss.Core.

What a controller file says, to read, change and write back.

public sealed class ControllerDocument

Remarks

The engine reads the same file and is the judge of it: a condition is checked by the world (World.CheckCondition), and a value out of its range is refused when the file is read. This reads what it can and says what it cannot.

Properties

Layers

public List<ControllerLayer> Layers { get; }

Its layers, the first at the bottom.

Methods

Copy

public ControllerDocument Copy()

A copy, every layer copied too.

Parse

public static ControllerDocument Parse(string text)

Reads a controller file's text.

Parameters

  • text

Exceptions

  • FormatException: It is not JSON, not a controller file, of a newer version, or of the wrong shape.

Text

public string Text()

The file's text: two spaces in, its keys in one order, what is as it starts left out.

A condition is written as it was typed, && and < as they are, not escaped for a web page.