game.list_move_in_sites
Overview
- Lists unowned residence sites the current household could move into, cheapest affordable first. Reads the world map UI data when the map is open, otherwise falls back to UB1SiteManager (in which case prices come from the site table defaults and enough_money is reported optimistically as true). Returns an empty array before the initial site selection is ready - poll game.get_state until map_mode == 'select_init_house'.
Metadata
| Field | Value |
|---|---|
| Display | List Move-In Sites |
| Category | game |
| Access | Public |
| Scope | B1Standalone |
| Tags | Experimental |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| only_affordable | bool | no | false | Only list sites the household can pay for without a mortgage. |
| limit | int | no | 50 | Maximum number of entries to return [1-500]. |
Usage
await inzoi.cli.execute('game.list_move_in_sites', {
only_affordable: false, // optional
limit: 50, // optional
});