Skip to main content

build

Overview

  • 17 commands in this category.

Commands

CommandNameDescription
build.enter_modeEnter Build ModeRequests entry into build mode for a site. This is ASYNCHRONOUS and returns as soon as the request …
build.exit_modeExit Build ModeRequests exit from build mode. This is ASYNCHRONOUS: poll build.get_mode_state until phase == 'none…
build.get_customize_infoGet Customize InfoReturns customizable parts and current material parameters of a game object (furniture, decoration,…
build.get_mode_stateGet Build Mode StateReturns whether build mode is active and which lifecycle phase it is in. Entering is asynchronous (…
build.get_site_infoGet Site InfoCALL THIS FIRST when you are about to build anything. It returns an aggregate summary of the curren…
build.remove_objectRemove Placed ObjectRemove a placed game object from the current site. In build mode the removal goes through the undo/…
build.reset_materialReset MaterialReset material parameters to default. If part_index is specified, resets only that part. Otherwise …
build.scan_floorsScan FloorsList floors and rooms in the current site with room indices, positions and wall-graph heights. Work…
build.scan_objectsScan Placed ObjectsList game objects placed in the current site with their entity IDs, table IDs, floor levels, and tr…
build.scan_wallsScan WallsList walls in the current site with edge keys and positions. Works in both play mode (character mus…
build.set_colorSet ColorChange the color of a game object. Supports hex (#FF0000) or named colors (red, blue, green, white,…
build.set_floor_colorSet Floor ColorChange floor (or ceiling) color. Works in both play mode (character must be inside a building) and …
build.set_floor_materialSet Floor MaterialChange floor (or ceiling) material preset. If material_group/material_index are omitted, a random v…
build.set_materialSet MaterialSet individual material parameters on a game object part. Specify only the parameters you want to c…
build.set_object_materialSet Object MaterialChange a game object's material preset (texture set). If material_group/material_index are omitted,…
build.set_wall_colorSet Wall ColorChange wall color. Works in both play mode (character must be inside a building) and build mode. Sp…
build.set_wall_materialSet Wall MaterialChange wall material preset. If material_group/material_index are omitted, a random valid preset is…