Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commit65083fe8f2

README.md

scene.remove

Remove entities from the active scene.

Takes the targets to remove: one name or id, several of them, or a selection such as every entity carrying a Light. The default floor is the entity named ground.

Targets are entity NAMES or ids, arrays of them, scene.find records, or a scene.find query — so you delete a selection without looking it up first. Each target is removed with its whole subtree.

A remove is a LIVE edit of the scene: scene.revert undoes it, and scene.save writes it into the scene's scene.json, which is the file zm add stages and zm commit records. To clear a scene while keeping the player setup, use scene.clean instead.

Returns removed, one { id, name } record per removed target, and playerHint when a target was part of the player setup.