build.enter_mode
Overview
- Requests entry into build mode for a site. This is ASYNCHRONOUS and returns as soon as the request is accepted: the entry runs a packet round-trip, a streaming grid load, a scene transition and then object spawning. Poll build.get_mode_state until phase == 'ready' before issuing any building.* command. If site_id is omitted the possessed character's home site is used, so a character must be possessed. Entering pauses the simulation.
Metadata
| Field | Value |
|---|---|
| Display | Enter Build Mode |
| Category | build |
| Access | UserCheat |
| Scope | B1Standalone |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| site_id | name | no | — | Target site id. Omit to use the possessed character's home site. |
| need_map_mode_open | bool | no | false | Allow entry while the map view is open |
Usage
await inzoi.cli.execute('build.enter_mode', {
site_id: '', // optional
need_map_mode_open: false, // optional
});