Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commit65083fe8f2

README.md

scene.summary

High-level "what's in the scene" report, and the call that counts the entities in the scene or in one group of it.

Every option is optional: limit, under, fields and includeInternal.

Returns { entityCount, rootCount, roots, truncated, more?, under?, activeCamera, player, startupScene }: the visible entity count, the top-level rows (with their hierarchy fields), the active camera id, the player setup with the verb that changes it, and the world's startup scene.

roots carries at most limit rows, 20 when the call names none. limit = 0 answers the counts, camera, player and startup scene alone, the read to make when the rows are not the question. rootCount is always the full count, and truncated with more says when rows were left out. An answer to a call naming neither limit nor fields carries narrowWith, the options that shorten it.

under names entities (an id, a name, a proxy, or an array of them) and scopes the report to what is beneath them: entityCount counts their descendants and roots holds their children. A reference that names no entity is refused by name. includeInternal = true counts entities marked internal too.

fields keeps only the named fields of the answer: { fields = { "entityCount" } } answers the count alone, the cheapest read to repeat while a scene changes. A name no answer carries is refused, and the refusal lists the fields.

For the full structure, scene.tree renders the hierarchy itself, and scene.find with roots set lists every root.