Scripting API

Scripting API

EntityKind

Enum in Abyss.Core, from Abyss.Core.

What sort of entity a EntityRow describes.

public enum EntityKind : uint

Remarks

A rule, not a guess. A Bevy world holds far more entities than a game put in it, and deciding which to hide by name, index or component count would be a heuristic that starts hiding a game's own entities the day one of them looks like an engine's. Upstream marks its own bookkeeping itself, and the engine reports what those markers say.

Values

NameValueDescription
Ordinary0An ordinary entity: something a game or an editor put in the world.
Engine1This entity exists to hold something that is not a thing in the world — a resource, a registered one-shot system, an observer — or stands for the engine's machinery: a window, a display, or a camera or surface the engine made to draw an interface.
Scene2This entity is a scene: it stands for everything in one rather than being a thing in the world itself. See World.CreateScene.
Loading4This entity is in a scene that is loading or unloading, and left out of every query until the scene is shown; see World.SetSceneLoading. A flag beside the others: such an entity is ordinary otherwise.
Ui8This entity is part of a UI document shown, which is not the scene's: the hierarchy leaves it out. A flag beside the others.
Draft16This entity is an element of a UI document being edited: left out of every query, and listed only while its document is open. See World.SetSceneDraft. A flag beside the others.