build.get_mode_state
Overview
- Returns whether build mode is active and which lifecycle phase it is in. Entering is asynchronous (packet round-trip, streaming grid load, scene transition, then object spawn completion), so poll until phase == 'ready' before issuing any building.* command. A transient 'none' can appear during the streaming step before the loading UI is shown; do not immediately re-issue build.enter_mode on a single 'none' reading. If phase stays 'leaving', check the 'stuck' field.
Metadata
| Field | Value |
|---|---|
| Display | Get Build Mode State |
| Category | build |
| Access | Public |
| Scope | B1Standalone |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| include_options | bool | no | false | Also embed the build option flags (same set as building.get_options). Only present while a build mode pawn exists. |
Usage
await inzoi.cli.execute('build.get_mode_state', {
include_options: false, // optional
});