build.remove_object
Overview
- Remove a placed game object from the current site. In build mode the removal goes through the undo/redo command stack with automatic price refund, so it can be reverted with building.undo (until build mode is left). In play mode the object is destroyed directly, the object's price is refunded to the household wallet, and the removal CANNOT be undone. Use build.scan_objects to discover entity IDs.
Metadata
| Field | Value |
|---|---|
| Display | Remove Placed Object |
| Category | build |
| Access | ScriptCheat |
| Scope | B1Multicast |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_id | entityId | yes | — | Target game object entity ID (from build.scan_objects) |
Usage
await inzoi.cli.execute('build.remove_object', {
entity_id: 0,
});