Skip to main content

building.set_floor_view

Overview

  • [Build Mode Only] Switches which floor the build mode is showing and editing, the same state the PgUp/PgDn keys and the up/down floor buttons on the build toolbar change. This is the value build.get_mode_state reports as 'customizing_floor', and it decides which floor's walls and objects are visible and clickable. Note that it is a VIEW state, not an edit: it is not undoable and building.undo will not move it. It does NOT change where building.place_object or building.construct_wall build - those take their own floor_level - but you normally want the two to agree before taking a screenshot. Levels outside the site's existing floor range are clamped; check 'clamped' and 'customizing_floor' in the response. Requires phase == 'ready' (see build.get_mode_state).

Metadata

FieldValue
DisplaySet Floor View
Categorybuilding
AccessScriptCheat
ScopeB1Standalone
TagsExperimental
Aliases—

Parameters

NameTypeRequiredDefaultDescription
floor_levelintyes—Absolute floor level to view (0 is the ground floor; negatives are basements)

Usage

await inzoi.cli.execute('building.set_floor_view', {
floor_level: 0,
});