game.new_game
Overview
- Starts a fully automated new game from the lobby: clicks New Game, randomizes the first character at the requested age, creates the family, submits the approval document, picks a city, waits for the level to load, moves into a residence site and enters play. This is ASYNCHRONOUS and returns as soon as the flow is accepted. Poll game.get_state: 'flow.step' tracks progress and 'phase' becomes 'in_game' when finished. Each step has a timeout (120s by default, 600s for level load and in-game entry) and there is NO automatic retry - on timeout flow.step becomes 'failed' and flow.last_error explains where it stopped. The one exception is the final 'dismiss_intro_ui' step: the game is already playable there, so a timeout still ends as flow.step == 'done' and only records the reason in flow.last_error. Must be called from the lobby, or with force=true from anywhere (the flow then returns to the lobby by itself first).
Metadata
| Field | Value |
|---|---|
| Display | Start New Game (Automated) |
| Category | game |
| Access | UserCheat |
| Scope | B1Standalone |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| map_id | name | no | — | Target city id (Map table row id). Omit to use the first released playable city. |
| site_id | name | no | — | Residence site to move into. Omit to auto-pick the cheapest affordable one (same ordering as game.list_move_in_sites). |
| growth_step | string | no | Youth | EB1GrowthStep enumerator name for the created character. Default 'Youth' (young adult). NOTE: 'Adult' means middle-aged, not young adult. |
| family_name | string | no | — | Family name. Omit to let the game use the first member's surname. |
| mortgage | bool | no | true | Take a mortgage when the household cannot afford the site, so any site can be moved into. |
| dismiss_intro_ui | bool | no | true | Automatically close the intro cat-talk / coach marks / popups after entering play. |
| force | bool | no | false | Cancel an already running flow and restart. Also allows starting from outside the lobby: the flow then goes back to the lobby itself (flow.step == 'wait_lobby', 120s timeout) before clicking New Game. Without it, a non-lobby phase is rejected. |
Usage
await inzoi.cli.execute('game.new_game', {
map_id: '', // optional
site_id: '', // optional
growth_step: 'Youth', // optional
family_name: '', // optional
mortgage: true, // optional
dismiss_intro_ui: true, // optional
force: false, // optional
});