Skip to main content

smartbuild.preview_wall

Overview

  • Temporarily apply an image to a wall 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 Wall Texture (Drag)
Categorysmartbuild
AccessScriptCheat
ScopeB1Standalone
TagsExperimental
Aliases

Parameters

NameTypeRequiredDefaultDescription
edge_keyintyesTarget wall edge key (from build.scan_walls or smartbuild.pick_surface_at_screen)
floor_levelintyesFloor level of the target wall
sidestringnobothWhich side: front, back, or both (default)
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_wall', {
edge_key: 0,
floor_level: 0,
side: 'both', // 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
});