building.put_in_inventory
Overview
- [Build Mode Only] Moves one or more placed objects into the household inventory through the build undo/redo stack. Multiple objects are batched into a SINGLE undo step (unlike building.move_object, which creates one step per object). If neither entity_id nor entity_ids is given, the current build-mode selection is used. Requires phase == 'ready' (see build.get_mode_state).
Metadata
| Field | Value |
|---|---|
| Display | Put Object In Inventory |
| Category | building |
| Access | ScriptCheat |
| Scope | B1Standalone |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_id | entityId | no | — | Single target entity ID (from build.scan_objects) |
| entity_ids | string | no | — | Comma-separated entity IDs for a batch, e.g. 123,456,789 |
| destroy_when_cannot_put_in | bool | no | true | Destroy the object when the inventory cannot accept it |
Usage
await inzoi.cli.execute('building.put_in_inventory', {
entity_id: 0, // optional
entity_ids: '', // optional
destroy_when_cannot_put_in: true, // optional
});