Scripting API

Scripting API

SceneId

Record struct in Abyss.Core, from Abyss.Core.

A scene: the entity that stands for everything one load built, or one script made.

public readonly record struct SceneId

Remarks

A scene is an entity. It is called what its file is called, it knows the file, and the world lists every scene there is (World.Scenes). Each entity in it says so, and the engine keeps the scene's list of them from that, so an entity a system spawns into the scene is in it and one that dies is not, with nobody keeping a list. A child is always in its parent's scene; see CommandBuffer.MoveToScene.

Never written to a file: an entity id means nothing outside the run that made it, so a saved scene omits which scene its entities were in and a load makes a fresh one.

Constructors

SceneId

public SceneId(ulong Value)

A scene: the entity that stands for everything one load built, or one script made.

Parameters

  • Value: The scene's entity.

A scene is an entity. It is called what its file is called, it knows the file, and the world lists every scene there is (World.Scenes). Each entity in it says so, and the engine keeps the scene's list of them from that, so an entity a system spawns into the scene is in it and one that dies is not, with nobody keeping a list. A child is always in its parent's scene; see CommandBuffer.MoveToScene.

Never written to a file: an entity id means nothing outside the run that made it, so a saved scene omits which scene its entities were in and a load makes a fresh one.

Properties

Value

public ulong Value { get; init; }

The scene's entity.

None

public static SceneId None { get; }

No scene: what an entity in none is in.