Skip to main content

smartbuild.preview_floor

Overview

  • Temporarily apply an image to a floor or ceiling for drag-over preview. The floor is snapshotted so smartbuild.preview_clear can restore the original look. Call smartbuild.preview_commit to keep the change or smartbuild.preview_clear to cancel. Supports path_key (reuse an already imported image) or file_path (import first).

Metadata

FieldValue
DisplayPreview Floor/Ceiling Texture (Drag)
Categorysmartbuild
AccessScriptCheat
ScopeB1Standalone
TagsExperimental
Aliases

Parameters

NameTypeRequiredDefaultDescription
floor_levelintyesFloor level that owns the target room (ceiling target: use the lower floor that contains the room)
room_indexintyesRoom index on the floor (from build.scan_floors or smartbuild.pick_surface_at_screen)
is_ceilboolnofalsetrue to apply to the ceiling instead of the floor (default false)
path_keystringnoExisting MyTexture path key to reuse (skip import)
file_pathstringnoImage file path. Used when path_key is omitted.
pattern_scalefloatnoOptional pattern tiling. 1.0=default, larger value=more repeats (smaller pattern). Used by drag-and-drop pan/scale.
pattern_offset_xfloatnoOptional pattern UV offset X. 0=default. Used by drag-and-drop pan.
pattern_offset_yfloatnoOptional pattern UV offset Y. 0=default. Used by drag-and-drop pan.
site_idstringnoOptional. Target site (from smartbuild.pick_surface_at_screen). Default: current site.

Returns

  • Return shape is not declared for this command.

Usage

await inzoi.cli.execute('smartbuild.preview_floor', {
floor_level: 0,
room_index: 0,
is_ceil: false, // optional
path_key: '', // optional
file_path: '', // optional
pattern_scale: 0.0, // optional
pattern_offset_x: 0.0, // optional
pattern_offset_y: 0.0, // optional
site_id: '', // optional
});