vw_insert_hoists
Places Spotlight hoists at specified points using an existing hoist symbol, setting capacity, chain, motor, and ID data in one revertible all-or-nothing step.
Instructions
Place Spotlight hoists (BrxHoist plug-in objects) at points, one revertible step. Each hoist gets the symbol's capacity, chain weight and length, motor weight, voltage, speed and motor height (from the symbol's HoistObjectData, as the Hoist tool does), its ID, location, function, direction and hook height. Linking to a truss system is left to Vectorworks' own hoist tools. All-or-nothing; vw_revert_last removes every hoist placed. Returns {symbol, count, hoists: [{uuid, id, x, y}], class?}; the derived values (hook height, chain length, weight) exist after the regeneration: read them with vw_list_hoists.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"symbol": "<symbol>",
"points": "<points>",
"height": "<height>"
},
"name": "vw_insert_hoists"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Hoist IDs, one per point, in order (motor numbers such as 'M1' or '1A'). Omitted: id_prefix plus 1, 2, 3 ... | |
| layer | No | Design layer to place the new object(s) on, by name. Omitted: the user's active layer. | |
| notes | No | Notes field of every hoist. | |
| height | Yes | Hook height above the low point, as a dimension string: '12 m', '39'4"', '15000 mm', or a number in document units. Sets the hoist's hook-to-hook distance and chain length. | |
| points | Yes | [[x, y], ...] in document units: one hoist per point, usually on a truss run (vw_list_truss gives piece centres). | |
| symbol | Yes | Name of a hoist symbol already in the document (vw_list_symbols), such as 'Dead Hang 1 Ton Audio' or a chain motor from the Rigging/Hoists libraries (vw_list_library, then vw_import_resource). It must carry a HoistObjectData record. | |
| document | No | Name of the document this call may change, as listed by vw_list_documents. If given and another document is in front, nothing changes and the call fails; use vw_switch_document first. Always pass it for writes. | |
| function | No | What the hoist carries: Lights, Audio, Video, Scenery, Other. Omitted: the symbol's own function. | |
| location | No | Location text shown in the hoist's data (the truss or position it picks up, such as 'US TRUSS'). Omitted: blank. | |
| hoist_pos | No | 'up' (default): motor at the top, the usual chain hoist; 'down': motor climbs, hangs from the load. | up |
| id_prefix | No | Prefix for automatic hoist IDs when ids is omitted. | M |
| class_name | No | Class to assign to the new object(s), by name; it must exist (vw_create_class or vw_apply_class_standard first). Applied in a second job after the insert. Omitted: the user's active class. |