Skip to main content

building.get_options

Overview

  • [Build Mode Only] Returns all build mode option states as JSON.

Metadata

FieldValue
DisplayGet Build Options
Categorybuilding
AccessPublic
ScopeB1Standalone
Tags
AliasesGetBuildOptions

Parameters

  • This command takes no parameters.

Returns

Returns a JSON object with the following fields:

FieldTypeRequiredDescription
free_locationboolyesFree object placement without snapping
grid_snapboolyesSnap objects to grid
object_snapboolyesSnap objects to other objects
uniform_scalingboolyesScale all axes uniformly
smart_guideboolyesShow smart alignment guides
delete_modeboolyesDelete mode enabled
continuous_placementboolyesPlace objects continuously

Usage

await inzoi.cli.execute('building.get_options');