Apply favorite
apply_favoriteApply an Archicad favorite: use Defaults to set current tool settings for new elements, or Elements to inject settings into existing same-type elements while preserving geometry, position, and story.
Instructions
Applies a favorite. target 'Defaults' (default) makes it the current settings of its tool, like double-clicking it in the Favorites palette — elements created afterwards (in Archicad or with create_* tools without explicit values) get these settings. target 'Elements' injects its settings into existing elements of the SAME type (geometry, position and story are kept). Output: {favorite, type, variation?, target, applied? (Defaults), results?: [{guid, applied: true} | {error}] (Elements), warnings?}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Exact favorite name (localized, as listed by get_favorites) | |
| target | No | 'Defaults' (tool settings) or 'Elements' (existing elements). Default: Elements when elements are given, else Defaults | |
| elements | No | target Elements: the elements to change (must be of the favorite's type) | |
| undoName | No | ||
| applyCategories | No | Also apply the favorite's element categories (default true) | |
| applyProperties | No | Also apply the favorite's stored property values (default true) | |
| applyClassifications | No | Also apply the favorite's classifications (default true) |