Skip to content

@modoki/engine / index / EntityInfo

Interface: EntityInfo ​

Entity info returned by getAllEntities

ECS Core ​

children? ​

optional children?: EntityInfo[]


editorFolder? ​

optional editorFolder?: string

Editor Hierarchy folder path (EntityAttributes.editorFolder). Only meaningful on roots (parentId 0); '' / undefined = ungrouped.


guid? ​

optional guid?: string

Stable EntityAttributes.guid ('' if never assigned). Lets the editor key per-entity view state (e.g. Hierarchy expand/collapse) to something that survives the runtime-id reassignment on every scene reload.


id ​

id: number


isResource? ​

optional isResource?: boolean


layer? ​

optional layer?: "3d" | "2d" | "ui"


name ​

name: string


parentId ​

parentId: number


sortOrder ​

sortOrder: number


sourceScene? ​

optional sourceScene?: string

Base-scene persistence provenance (EntityAttributes.sourceScene) — the guid of the scene (in the active chain) this entity was loaded from. '' / undefined = the primary scene (Phase 3's load-bearing default). Stamped on every entity a base scene spawns, not just its roots, so a descendant reads its OWN value rather than inheriting from an ancestor. Drives the Hierarchy's scene-group ghosting (base-scene plan Phase 9).


traits ​

traits: string[]

Built with Modoki.