Get tool default settings
get_tool_defaultsRetrieve default settings for Archicad element tools to see current values and field names before modifying them.
Instructions
Returns the default settings of element tools — what the next element placed in Archicad (or created by a create_* tool without explicit values) gets. Without type/types: lists the toolbox tools {tools: [{type, variation?}], activeTool, hint}. With types: {defaults: [{type, variation?, settings: {layer, renovationStatus, drawIndex, elementId?, ...the same fields as the type's create_* tool (heights, thicknesses, structure/composite/buildingMaterial, surfaces, libraryPart, params {GDL name: value}...), gdlParameterCount?}, classifications?: [{system, systemGuid, itemGuid, itemId, itemName}], categories?: {StructuralFunction: {value, valueGuid, category}, ...}, properties?: [{guid, name, group, value | status}], notes?} | {error}]}. Use it before set_tool_defaults to see the current values and field names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Tool to read (e.g. 'Wall') | |
| types | No | Several tools at once: type names or {type, variation} | |
| variation | No | Tool variation, only for tools that share an element type (e.g. 'GridElement' vs 'Object' for Object elements). Normally omit it; get_tool_defaults without a type lists the toolbox tools with their variations | |
| gdlParameterNames | No | Only these GDL parameters (names as in get_gdl_parameters) | |
| includeCategories | No | Include the default element categories (default true) | |
| includeProperties | No | Include custom properties whose default value was overridden (default false) | |
| includeAllProperties | No | Include ALL custom properties available for the tool, with their values (default false) | |
| includeGdlParameters | No | Library-part based tools: include the GDL parameter values (default true) | |
| includeClassifications | No | Include the default classifications (default true) | |
| includeHiddenGdlParameters | No | Also include hidden GDL parameters (default false) |