vw_insert_lighting_devices
Hangs a row of lighting fixtures as real Spotlight Lighting Devices at a set spacing and rotation, assigning position, unit numbers, channels and purpose in one revertible step.
Instructions
Hang a row of lighting fixtures as real Spotlight Lighting Devices with position, unit numbers, channels and purpose set.
Places the symbol count times from (x, y) along rotation, spacing
apart, and converts each to a Lighting Device the way Spotlight's
insertion tool does, so Inst Type, wattage, DMX footprint and GDTF data
come from the symbol. To change fixtures that already exist use
vw_set_lighting_device_fields; to place a plain (non-fixture) symbol use
vw_insert_symbol. All-or-nothing; one revertible step removes them all.
Fields are re-read after Spotlight's reset: trust the returned values, and
anything Spotlight overrode is listed under not_applied. Returns
{devices: [{uuid, unit, inst_type, Position, Unit Number, Channel, Purpose,
Inst Type}], imported, z, class?, not_applied?}.
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>",
"x": "<x>",
"y": "<y>"
},
"name": "vw_insert_lighting_devices"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | First fixture's x in document units. | |
| y | Yes | First fixture's y in document units. | |
| z | No | Explicit hanging height in document units. Omitted: the position's height. | |
| count | No | How many fixtures to hang in a row; at least 1. | |
| layer | No | Design layer to place the new object(s) on, by name. Omitted: the user's active layer. | |
| symbol | Yes | Name of a fixture symbol already in the document (vw_list_symbols), or in the library file given as library_path. | |
| channel | No | Channel of the first fixture; following ones add channel_step. Omitted: Channel left empty. | |
| purpose | No | Text for the object's Spotlight 'Purpose' field. Omitted: left empty. | |
| spacing | No | Distance between fixtures in document units, measured along `rotation`. 0 with count > 1 stacks them on one point. | |
| 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. | |
| position | No | Spotlight Position name to hang them on, as listed by vw_list_positions; the fixtures are raised to that position's height unless z is given. Omitted: no position, height z or 0. | |
| rotation | No | Direction of the row in degrees: 0 = along +x, 90 = along +y. | |
| unit_step | No | Increment of the Unit Number from one fixture to the next. | |
| 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. | |
| start_unit | No | Unit Number of the first fixture; following ones add unit_step. None leaves Unit Number empty. | |
| channel_step | No | Increment of the Channel from one fixture to the next. | |
| library_path | No | Library .vwx path (vw_list_library) to import the symbol from first, when it is not in the document yet. |