Scripting API

Scripting API

SceneExpansion

Record in Abyss.Core.Scenes, from Abyss.Core.

What an expansion produced: a document with no instances left in it.

public record SceneExpansion

Constructors

SceneExpansion

public SceneExpansion(SceneDocument Document, IReadOnlyDictionary<int, AssetGuid> Instances, IReadOnlyList<string> Notes, IReadOnlyDictionary<int, AssetGuid> Supplied, IReadOnlyDictionary<int, AssetGuid> Templates)

What an expansion produced: a document with no instances left in it.

Parameters

  • Document: The same scene with every instance replaced by the entities it stands for.
  • Instances: Which entities of Document are the root of an instance, and of what. The load puts a PrefabInstance on each, which is how a later capture writes one reference back instead of a subtree.
  • Notes: What could not be expanded, in words.
  • Supplied: Which entities of Document a prefab supplied inside an instance, and which prefab's file holds each — as opposed to what the scene added there. The load puts a PrefabPart on each, which is how an editor tells what it may move.
  • Templates: Which entities of Document are the top of an instance of a UI document that a prefab's own file placed — one not among Instances — and of which. The load puts a UiTemplate on each, which is how the game tells a template placed in a document it shows.

Properties

Document

public SceneDocument Document { get; init; }

The same scene with every instance replaced by the entities it stands for.

Instances

public IReadOnlyDictionary<int, AssetGuid> Instances { get; init; }

Which entities of Document are the root of an instance, and of what. The load puts a PrefabInstance on each, which is how a later capture writes one reference back instead of a subtree.

Notes

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

What could not be expanded, in words.

Supplied

public IReadOnlyDictionary<int, AssetGuid> Supplied { get; init; }

Which entities of Document a prefab supplied inside an instance, and which prefab's file holds each — as opposed to what the scene added there. The load puts a PrefabPart on each, which is how an editor tells what it may move.

Templates

public IReadOnlyDictionary<int, AssetGuid> Templates { get; init; }

Which entities of Document are the top of an instance of a UI document that a prefab's own file placed — one not among Instances — and of which. The load puts a UiTemplate on each, which is how the game tells a template placed in a document it shows.