Scripting API

Scripting API

SceneLoad

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

What came of building a scene in a world.

public record SceneLoad

Constructors

SceneLoad

public SceneLoad(SceneId Scene, IReadOnlyList<ulong> Entities, IReadOnlyDictionary<string, ulong> Named, IReadOnlyList<string> Notes)

What came of building a scene in a world.

Parameters

  • Scene: The scene every entity was put in, which is how it is found, saved or unloaded later. Nothing in the file said what it would be.
  • Entities: The entities that were spawned, in the document's order.
  • Named: The entities the document named, by that name — which is how a caller finds the one it cares about in a scene it did not write.
  • Notes: What the load could not honor: a component this world does not have, a mesh nobody supplied, a field that has changed shape. Repeats are collapsed.

Properties

Scene

public SceneId Scene { get; init; }

The scene every entity was put in, which is how it is found, saved or unloaded later. Nothing in the file said what it would be.

Entities

public IReadOnlyList<ulong> Entities { get; init; }

The entities that were spawned, in the document's order.

Named

public IReadOnlyDictionary<string, ulong> Named { get; init; }

The entities the document named, by that name — which is how a caller finds the one it cares about in a scene it did not write.

Notes

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

What the load could not honor: a component this world does not have, a mesh nobody supplied, a field that has changed shape. Repeats are collapsed.