Scripting API

Scripting API

GameStart

Class in Abyss.Core, from Abyss.Core.

The game starting: what a plugin's IPlugin.BeforeFirstScene is given, before any scene is read — to read a save, sign in, fetch what the game is set up with, and choose the scene it opens. See GameCode.

public sealed class GameStart : GameCode

Properties

FirstScene

public SceneAddress? FirstScene { get; set; }

The scene the game opens, by its key: its build's first, until a plugin says another — a scene's key the build wrote, Addresses.Scenes.Title, or one made from its identity, SceneAddress.FromId(id) — or null for none. In the editor, which plays the scene that is open, it is null, and what is set here is passed over.

InEditor

public bool InEditor { get; }

Whether the game is played in the editor, from the scene open there, rather than built.