Checks#

Checks allow access to the internal data structures of Production Assist using a simplified JavaScript-API and so on automate complex checks.

Multiple scripts can be created for each project. Scripts can also be created across users and used in multiple projects. The checks can be viewed in Resource Manager -> "Automatic Checks".

Editor#

The editor allows editing the code on the left and offers a list of available commands on the right. The list of commands is created dynamically. Every function requires an object as the first argument, possibly an empty object, and always returns an object, a list or undefined back. The following functions are used particularly frequently:

Command	Arguments	Description
LR_GetObjectTree	`{IncludeGeometries?: boolean, IncludeProperties?: string[]}`	Returns all objects (and some of their internal data) in the current drawing as a flat, sorted list
LR_GetObject	`{UUID: uuid}`	Returns an object and all of the object's internal data. The UUID identifies every object in Production Assist and can be used via `LR_GetObjectTree` or `LR_GetFirstObject` be received.

In addition to the internal Production Assist functions are also available Three editor functions available:

Command	Description	Example
log	Prints a string value to the output	`var t = LR_GetObjectTree({}); log(t[0].Name)`
check	Checks whether the first argument `true` is, if not, the second argument is printed	`var t = LR_GetLinkedProject({}); check(t.Project !== "", "Projekt ist nicht mit der cloud verknüpft")`
analyze	Prints the contents of an object to the output. Different to `log` it also allows printing of objects	`var t = LR_GetFirstObject({}); analyze(t)`

Using Scripts#

Scripts can be incorporated into the workflow in several ways:

They can be done manually
You can enter calculation reports via "File" -> "Export calculation report as PDF..." using the %%SCRIPT_PROVE_CHECK(SkriptName)%% be inserted
They can be used as an automatic check when collaborating

In all cases, the script is not only executed, but also checked for errors. In addition to JavaScript errors, this also includes all of them check-Functions whose first argument false results.

Tips and Tricks#

Values returned by Production Assist functions are always created dynamically and can change depending on the context and drawing. Data that can be found in one object can also be found in other objects. By means of the analyzefunction, an object and its data can be viewed and the structure of other objects can be deduced.
The log-Function can only output one string at a time, but JavaScript allows numbers, objects and strings to be combined. Line breaks can be done using the control character \n be inserted. See examples
Scripts are self-contained and do not allow access to the data of previous scripts. However, there is one exception to this for calculation reports: If several scripts are created using the %%SCRIPT_PROVE_CHECK(SkriptName)%%clause is executed, subsequent scripts can access all global data from previous scripts

Examples#

Data from Production Assist-Analyze#

var tree = LR_GetObjectTree({})

analyze(tree[0])

for(var t = 0; t < tree.length; t++){
  log(tree[t].Name)
}

Save the Current Renderer View as a View#

var obj = LR_AddNewSavedView({Name:'My new name'})
log(obj.Name)

`log`-Function#

var a = 1
var b = "test"

log("result: " + a + " -- " + b)

`check`-Function#

var tree = LR_GetObjectTree({})

var a = tree[4]
var b = tree[5]

check(a.Weight > 0, "Item " + a.Name + " has no weight! Check the Object")

`analyze`-Function#

var tree = LR_GetFirstObject({})

analyze(tree)

Differences from Other JavaScript Engines#

Production Assist uses a minimized JavaScript engine, which does not provide some features of the modern JavaScript. These include in particular:

let is not available
for(... of ...) Loops are not available
async / await is not available
console.log is not available

LightRight C++ → JS Bridge API reference#

Complete reference of all API functions available from the C++ core (core/jsbridge/module_main.cpp) can be exported via NAN to JavaScript.

Table of Contents#

Initialization & Lifecycle
File Operations
Server Synchronization
Object Tree Navigation
Object Creation & Deletion
Object Properties & Editing
Selection & Tree Operations
Hierarchical Operations
Geometry Operations
Geometry Editing Modes
Electrical Connections
DMX & Fixtures
Presets & States
Worksheets
Layers
Classes
Selection Groups
Inventory: Trucks, Cases & Racks
Users
Meshes & Textures
Import Formats
Export Formats
Symbol Definitions
Resources & Server Resources
Authentication & Login
Collaboration & Sharing
Templates: Cross Sections
Templates: Materials
Templates: Symbol Maps
Templates: Trucks, Cases & Racks
Templates: Paper & Print Formats
Templates: Property Templates
Templates: Connectors
Templates: Bridle Parts Sets
Templates: Calculation & Documentation Reports
VW Field Mapping
Color Codes
Departments
Load Combinations & Groups
Structural Calculations & Results
Support & Hoisting
Timeline & Phases
Notes
Saved Views
Print Labels
Graph Groups
Batch & Array Operations
Ordering Operations
Undo/Redo
Clipboard Operations
Duplication & Mirroring
Patching & Data Patching
Assembly Groups & Sorting
Settings & Configuration
Dialogs & User Interface
Print & Export Views
MA3 / DMX Monitoring
Log100 Connections
Network & Remote Access
MVRxchange Integration
Host Application Integration
Linked Projects & Branches
Custom Checks & Validation
Custom Scripts & Commands
Chatbot Settings
Gels & Color Filtering
Property Management
Costs & Pricing
Digital Signing
Tabular Calculations
Miscellaneous Utilities
Testing & Debugging
DWG Library

1. Initialization & Lifecycle#

`LR_SetEnvironment`#

Initializes the application environment with paths and startup options.

Parameter	Type	Description
AppDataPath	String	Custom app data directory
GeneralAppDataPath	String	Shared app data directory
AppDir	String	Application installation directory
HomeDir	String	User home directory
StartServer	Bool	Specifies whether to start the integrated server
StartWebSockets	Bool	Specifies whether to start WebSocket connections
OnlyUseVRConnection	Bool	Use VR transport only
TestDefined	Bool	Runs in test mode
SlowTestDefined	Bool	Runs the slow test suite
DownloadDir	String	Path to the download directory

`LR_MainTick`#

Executes a tick of the main application loop. No parameters.

`LR_Sleep`#

Pauses the current thread for a specified duration.

Parameter	Type	Description
Milliseconds	Integer	Sleep time in milliseconds (default: 200)

`LR_BeforeShutDownApp`#

Performs shutdown preparation. Returns JSON AllowClose (Bool) back.

`LR_ReloadUI`#

Forces a UI reload. No parameters.

2. File Operations#

`LR_OpenLRWFile`#

Opens a LightRight project file.

Parameter	Type	Description
Path	String	File path (optional, opens file selector if empty)
Async	Bool	Specifies whether to open asynchronously

`LR_OpenLRWFileFromUrl`#

Downloads a project from the server and opens it.

Parameter	Type	Description
User	String	Server username
Project	String	Projektkennung
Branch	String	Branch name
SigningJob	String	Signing job ID (optional)
Async	Bool	Specifies whether to open asynchronously

`LR_OpenLRWFolder`#

Opens a folder-based project with session tracking.

Parameter	Type	Description
Path	String	Ordnerpfad
FileID	String	Dateikennung
SessionID	String	Session tracking ID
Async	Bool	Specifies whether to open asynchronously

`LR_CloseLRWFile`#

Closes a drawing file.

Parameter	Type	Description
Path	String	File path (optional)
SessionID	String	Session to be cleaned up

`LR_SaveFile`#

Saves the drawing to disk.

Parameter	Type	Description
Path	String	Save path (optional, uses current path or opens dialog)
SaveAs	Bool	Forces the Save As dialog

`LR_SaveSceneJson`#

Saves the drawing as a raw JSON scene file.

Parameter	Type	Description
Path	String	Output file path

`LR_DisableAutosaveTimer`#

Enables or disables autosave.

Parameter	Type	Description
DisableAutosaveTimer	Bool	true to disable

`LR_GetCurrentDrawingPath`#

Returns the file path of the active drawing. Returns JSON.

`LR_GetDrawings`#

Returns a list of all open drawings with the UUID of the active drawing. Returns JSON.

`LR_DrawingPathExist`#

Checks whether a drawing with the specified path is already open. Returns JSON (Bool).

`LR_SetActiveDrawing`#

Switches to a specified drawing or removes a server copy.

Parameter	Type	Description
DrawingUUID	UUID	Drawing to activate (optional)
DeleteServerDrawing	Bool	Specifies whether to remove the server copy

`LR_CreateNewDrawing`#

Creates a new blank drawing. No parameters.

`LR_GetAvailableWebsocketPorts`#

Reads available WebSocket ports from the configuration. Returns a JSON array.

3. Server Synchronization#

`LR_CheckoutProject`#

Downloads a project from the server and opens it as a new drawing.

Parameter	Type	Description
Project	String	Projektkennung
User	String	Server username
Branch	String	Branch name
BranchName	String	Branch display name

`LR_CommitToServer`#

Transfers current drawing changes to the server. If there are conflicts, a diff dialog is displayed. No parameters. Asynchronous.

`LR_CommitApprovedChanges`#

Completes a server commit after conflict resolution.

Parameter	Type	Description
Differences	JSON	Approved changes from the diff dialog
Message	String	Commit message

`LR_CommitRessourceDrawing`#

Transfers a resource drawing to the server. No parameters. Asynchronous.

`LR_CommitRessourceDrawingApprovedChanges`#

Completes the commit of a resource drawing after conflict resolution.

Parameter	Type	Description
Differences	JSON	Approved changes
Message	String	Commit message

`LR_UpdateFromServer`#

Retrieves the latest changes from the server and displays the diff dialog. No parameters. Asynchronous.

`LR_UpdateApprovedChanges`#

Applies approved changes from a server update to the active drawing. Expects the diff data as an input object.

`LR_CheckoutRessourceDrawing`#

Downloads a resource drawing from the server and opens it.

Parameter	Type	Description
Identifier	String	Resource identifier
RevisionId	String	Revision ID
User	String	Server username

`LR_CompareToActiveDrawing`#

Compares a drawing file with the active drawing.

Parameter	Type	Description
UUID	UUID	Drawing to compare

`LR_CompareTwoServerDrawings`#

Compares two server-side drawings.

Parameter	Type	Description
Folder	String	Projektordner
Base	String	Basic revision
Target	String	Target revision

`LR_MergeTwoServerDrawings`#

Merges two server-side branches.

Parameter	Type	Description
Folder	String	Projektordner
Base	String	Base branch
Target	String	Target branch
Option	Object	Merge options (CopyResources, UpdateObjects)
BaseOnly	Array	Elements only in the base
TargetOnly	Array	Elements only in the target

`LR_MergeTwoServerDrawingsTemplate`#

Merges two server drawings using template matching.

Parameter	Type	Description
FolderBase	String	Basisordner
FolderTarget	String	Target folder
Base	String	Basiskennung
Target	String	Zielkennung

`LR_ApplyDiff`#

Applies a diff to the drawing.

Parameter	Type	Description
ApplyTo	UUID	Zielzeichnung
ApplyFrom	UUID	Quellzeichnung
Diff	Object	Diff data

`LR_UpdateFromBranch`#

Synchronized from a server branch.

Parameter	Type	Description
Branch	String	Branch name

`LR_UpdateFromTemplate`#

Updates the drawing based on a linked template. No parameters.

`LR_CreateBranchAsync`#

Asynchronously creates a new project branch.

Parameter	Type	Description
Name	String	Branch name

`LR_DeleteGroupOnServer`#

Removes a group on the server.

Parameter	Type	Description
Folder	String	Projektordner
GroupName	String	Group name
File	String	Dateikennung

4. Object Tree Navigation#

`LR_GetFirstObject`#

Returns the root object of the scene. Returns JSON.

`LR_GetFirstChild`#

Returns the first child of an object.

Parameter	Type	Description
UUID	UUID	Parent object

`LR_GetNextObject`#

Returns the closest sibling of an object.

Parameter	Type	Description
UUID	UUID	Current object

`LR_GetObjectTree`#

Gets the hierarchical object tree with optional properties and geometry. Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root UUID (optional)
CompleteTree	Bool	Include full subtree
IncludeGeometries	Bool	Include geometry data
ForceObjectTree	Bool	Force tree structure
IncludeProperties	Array	Property names to include
IncludeGeometryProperties	Array	Geometry property names to include
ResolveContainer	Bool	Explode container objects
UseSorting	Bool	Enable sorting
OrderReversed	Bool	Reverse sort order

`LR_GetGeometryTree`#

Gets the geometry hierarchy for a container. Asynchronous.

Parameter	Type	Description
ObjectUUID	UUID	Root container UUID
ResolveContainer	Bool	Explode container objects

`LR_GetCompleteObject`#

Returns complete object data using the UUID.

Parameter	Type	Description
UUID	UUID	Object to retrieve

`LR_GetSelectiveObject`#

Returns an object with only selected properties. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object to retrieve
IncludeProperties	Array	Property names to include

`LR_GetCompleteFirstObject`#

Returns complete data for the root object. No parameters. Returns JSON.

`LR_GetCompleteFirstChild`#

Returns full data for the first child object.

Parameter	Type	Description
UUID	UUID	Parent object

`LR_GetCompleteNextObject`#

Returns full data for the next sibling element.

Parameter	Type	Description
UUID	UUID	Current object

5. Object Creation & Deletion#

`LR_AddNewObject`#

Creates a new drawing object with full transformation control. When insterting a Symbol (ResourceType : 3) make sure that this is the default symbol first.

Parameter	Type	Description
NoReturnValue	Bool	Skip return value for performance reasons
ResourceType	Integer	Resource type to create
magnetUUID	UUID	Magnet snap target (optional)
ResourceContainerUUID	UUID	Resource container reference
UUID	UUID	Predefined UUID (optional)
ParentUUID	UUID	Parent object
Matrix	Matrix4x4	Full transformation matrix (optional)
offsetMagnet	Bool	Apply magnetic offset
SnappedPoints	Array	Snap data
Px	Float	Position X
Py	Float	Position Y
Pz	Float	Position Z
P2x	Float	Viewpoint X
P2y	Float	Viewpoint Y
P2z	Float	Viewpoint Z
Qx	Float	Orientation quaternion
Qy	Float	Orientation quaternion
Qz	Float	Orientation quaternion
Qw	Float	Orientation quaternion
Sx	Float	Scaling X
Sy	Float	Scaling Y
Sz	Float	Scaling Z

`LR_AddNewObject_Line`#

Creates an array of objects along a line between two points.

Parameter	Type	Description
ResourceType	Integer	Resource type
DistanceBetweenObjects	Float	Distance between objects
ExtrusionHeight	Float	Extrusion height
Px1	Float	Startposition
Py1	Float	Startposition
Pz1	Float	Startposition
Px2	Float	Endposition
Py2	Float	Endposition
Pz2	Float	Endposition
Qx1	Float	Start orientation quaternion
Qy1	Float	Start orientation quaternion
Qz1	Float	Start orientation quaternion
Qw1	Float	Start orientation quaternion
Qx2	Float	End orientation quaternion
Qy2	Float	End orientation quaternion
Qz2	Float	End orientation quaternion
Qw2	Float	End orientation quaternion

`LR_AddObjectArray`#

Creates objects from a typed array definition.

Parameter	Type	Description
Type	Integer	Array type
Props	Object	Array properties

`LR_SetObjectArray`#

Updates an existing object array.

Parameter	Type	Description
Type	Integer	Array type
Props	Object	Updated properties

`LR_DeleteObject`#

Deletes a single object.

Parameter	Type	Description
UUID	UUID	Object to delete
IfSelectedAllSelected	Bool	Delete all selected when target is selected

`LR_DeleteSelectedObjects`#

Deletes all currently selected objects. No parameters.

`LR_DeleteObjects`#

Deletes multiple objects using a UUID list.

Parameter	Type	Description
UUIDList	Array	UUIDs to delete

6. Object Properties & Editing#

`LR_GetObject`#

Returns basic object information using the UUID.

Parameter	Type	Description
UUID	UUID	Object to retrieve

`LR_SetObject`#

Updates values in the Object Properties as well as position, rotation and scale.

Parameter	Type	Description
UUID	UUID	Object to update
UseDefault	Bool	Apply default values
Preset	UUID	Preset to apply (optional)
Use_quaternion_and_pos	Bool	Use position/quaternion transformations
Matrix	Matrix4x4	Full matrix (optional)
RotByDirStartX	Float	Direction of rotation start
RotByDirStartY	Float	Direction of rotation start
RotByDirStartZ	Float	Direction of rotation start
RotByDirEndX	Float	Direction of rotation end
RotByDirEndY	Float	Direction of rotation end
RotByDirEndZ	Float	Direction of rotation end
RotByDirUpX	Float	Rotation Up Vector
RotByDirUpY	Float	Rotation Up Vector
RotByDirUpZ	Float	Rotation Up Vector
Px	Float	Position X, Y, Z
Py	Float	Position X, Y, Z
Pz	Float	Position X, Y, Z
Qx	Float	Orientation quaternion
Qy	Float	Orientation quaternion
Qz	Float	Orientation quaternion
Qw	Float	Orientation quaternion
P2x	Float	Blickpunkt
P2y	Float	Blickpunkt
P2z	Float	Blickpunkt
Sx	Float	Scaling X, Y, Z
Sy	Float	Scaling X, Y, Z
Sz	Float	Scaling X, Y, Z

`LR_SetMultipleObjects`#

Batch updates properties of multiple objects. Expects an array of objects, each with UUID, UseDefault and Preset.

`LR_GetObjectProperties`#

Retrieves detailed properties of an object. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object (optional, uses selection)
CalcResults	Bool	Include calculation results

`LR_SetObjectProperties`#

Sets Object Properties with mode control.

Parameter	Type	Description
PropertySettingMode	Integer	Einstellungsmodus
ApplyToChildObject	Bool	Apply to child objects

`LR_SetAlignedValue`#

Sets an aligned/distributed property value across multiple objects.

Parameter	Type	Description
type	Integer	Ausrichtungstyp
Property	String	Property name
value1	JSON	Startwert
value2	JSON	Endwert
Preset	UUID	Preset reference (optional)

`LR_GetPropertyValue`#

Gets a single property value. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object
PropertyName	String	Property identifier
ArrayName	String	Array property name (optional)
ArrayPosition	Integer	Array index (optional)
IncludeUnit	Bool	Include unit in result

`LR_SetWeightForObject`#

Sets the weight for objects.

Parameter	Type	Description
Objects	Array	Object UUIDs
Weight	Float	Gewichtswert
SetForAll	Bool	Apply to everyone

`LR_MoveObjectToPoint`#

Moves objects to specific coordinates.

Parameter	Type	Description
Objects	Array	Object UUIDs
Payload	String	Zielkennung
MoveLoadPoint	Bool	Move load point
X	Float	Zielkoordinaten
Y	Float	Zielkoordinaten
Z	Float	Zielkoordinaten

7. Selection & Tree Operations#

`LR_Select`#

Selects objects with full mode control.

Parameter	Type	Description
SelectionMode	Integer	Auswahlmodus
SelectionGroupMode	Integer	Groupnauswahlmodus
SelectedList	Array	UUID list
PropertyName	String	Property for selection
ArrayName	String	Array property name
ShiftKey	Bool	Shift modifier
MetaKey	Bool	Meta/cmd modifier
AltKey	Bool	Alt modifier
Selected	Bool	Select/Deselect
UseDrawingOrder	Bool	Pay attention to the order of characters
ZoomToSelection	Bool	Automatically zoom to selection

`LR_SelectAll`#

Selects or deselects all objects.

Parameter	Type	Description
Value	Bool	true to select all, false to deselect

`LR_SelectChildren`#

Selects all children of an object.

Parameter	Type	Description
UUID	UUID	Parent object

`LR_CollapseChildren`#

Collapses child objects in the tree view.

Parameter	Type	Description
UUID	UUID	Parent object

`LR_SelectNext`#

Navigates and selects in the tree.

Parameter	Type	Description
SelectAddition	Bool	Add to selection

`LR_SelectPrev`#

Navigates and selects in the tree.

Parameter	Type	Description
SelectAddition	Bool	Add to selection

`LR_SelectUp`#

Navigates and selects in the tree.

Parameter	Type	Description
SelectAddition	Bool	Add to selection

`LR_SelectDown`#

Navigates and selects in the tree.

Parameter	Type	Description
SelectAddition	Bool	Add to selection

`LR_ExpandAll`#

Expands or collapses all tree nodes.

Parameter	Type	Description
Value	Bool	true to expand, false to collapse

`LR_GetSelectedObjects`#

Returns an array of UUIDs of selected objects.

Parameter	Type	Description
IncludeGeometries	Bool	Include geometry objects

`LR_GetSelectedObjectCount`#

Returns the number of selected objects. Returns JSON (Integer).

`LR_MoveSelectedUp`#

Moves selected objects up/down in the tree. No parameters.

`LR_MoveSelectedDown`#

Moves selected objects up/down in the tree. No parameters.

8. Hierarchical Operations#

`LR_SetChild`#

Makes one object the child of another.

Parameter	Type	Description
ParentUUID	UUID	New parent object
ChildUUID	UUID	Object to be reassigned
GlobalCoordinates	Bool	Maintain global position

`LR_SetNext`#

Sets the sibling relationship to the subsequent element.

Parameter	Type	Description
PrevUUID	UUID	Previous sibling element
NextUUID	UUID	Next sibling element
GlobalCoordinates	Bool	Maintain global position

`LR_SetPrev`#

Sets the sibling relationship to the previous element.

Parameter	Type	Description
PrevUUID	UUID	Previous sibling element
NextUUID	UUID	Current object
GlobalCoordinates	Bool	Maintain global position

`LR_GroupSelected`#

Creates a group from the current selection.

Parameter	Type	Description
Name	String	Group name

`LR_DisolveGroup`#

Dissolves objects from a group.

Parameter	Type	Description
UUID	UUID	Group to be disbanded

9. Geometry Operations#

`LR_GetFirstChildGeometry`#

Returns geometry objects using the UUID. Each function expects a UUID parameter.

`LR_GetNextGeometry`#

Returns geometry objects using the UUID. Each function expects a UUID parameter.

`LR_GetGeometry`#

Returns geometry objects using the UUID. Each function expects a UUID parameter.

`LR_GetGeometryTransformFromObject`#

Returns the transformation of a geometry relative to its parent object.

Parameter	Type	Description
Object	UUID	Parent object
Geometry	UUID	Geometrieobjekt

`LR_SetGeometry`#

Updates a geometry object.

Parameter	Type	Description
UUID	UUID	Geometry to update
Preset	UUID	Presets (optional)
UseDefault	Bool	Apply default values

`LR_SetGeometryDefiningResource`#

Associates a geometry with a resource definition.

Parameter	Type	Description
ObjectUUID	UUID	Object
GeometryUUID	UUID	Geometry

`LR_AddNewStructureGeometry`#

Creates a truss structure geometry between two points.

Parameter	Type	Description
ParentUUID	UUID	Parent object
Rotation	Float	Rotationswinkel
CrossSection	String	Querschnittsname
UseAsInternalStructure	Bool	Mark as internal structure
Name	String	Name
FromX	Float	Startpunkt
FromY	Float	Startpunkt
FromZ	Float	Startpunkt
ToX	Float	Endpunkt
ToY	Float	Endpunkt
ToZ	Float	Endpunkt
R	Float	Color (0.0–1.0)
G	Float	Color (0.0–1.0)
B	Float	Color (0.0–1.0)

`LR_AddNewSupportGeometry`#

Creates a bearing/hoist geometry.

Parameter	Type	Description
ParentUUID	UUID	Parent object
CrossSection	String	Querschnittsname
FromX	Float	Startpunkt
FromY	Float	Startpunkt
FromZ	Float	Startpunkt
ToX	Float	Endpunkt
ToY	Float	Endpunkt
ToZ	Float	Endpunkt

`LR_AddNewPolygonGeometry`#

Creates a polygon geometry.

Parameter	Type	Description
ParentUUID	UUID	Parent object
ObjectPath	Array	Path points.
Name	String	Polygonname
Closed	Bool	Closed path
Filled	Bool	Filled polygon

`LR_SetDefiningResourceGeometry`#

Updates the defining resource of a geometry.

Parameter	Type	Description
ObjectUUID	UUID	Object
GeometryUUID	UUID	Geometry

`LR_GetCrossSectionByColor`#

Gets a cross section associated with a color.

Parameter	Type	Description
CrossSectionBaseName	String	Basisname
R	Float	Farbwerte
G	Float	Farbwerte
B	Float	Farbwerte

10. Geometry Editing Modes#

`LR_OpenGeometryEditMode`#

Opens the geometry editor.

Parameter	Type	Description
UUID	UUID	Object to edit
Selected	Bool	Use selected objects
Object	Bool	Edit geometry at the object level

`LR_CloseGeometryEditMode`#

Closes the geometry editor.

Parameter	Type	Description
KeepChanges	Bool	Save changes on exit

`LR_GetGeometryEditMode`#

Returns the current edit mode state. Returns JSON.

`LR_OpenPolygonRendererViewEditMode`#

Opens the Polygon Renderer Editor.

Parameter	Type	Description
UUID	UUID	Object to edit

`LR_ClosePolygonRendererViewEditMode`#

Closes the Polygon Renderer Editor.

Parameter	Type	Description
RendererViewSavedView	Object	View state to restore

`LR_GetPolygonRendererViewEditMode`#

Returns the edit mode state of the polygon renderer. Returns JSON.

11. Electrical Connections#

`LR_AddElectricalConnection`#

Creates electrical connections at the connector level. Expects an array or a single object with from/to connection details.

`LR_RemoveElectricalConnection`#

Removes electrical connections at the connector level. Expects an array or a single object with from/to information.

`LR_ClearElectricalConnection`#

Deletes all connections on a specified port.

Parameter	Type	Description
Objects	Array	Object UUIDs
Socket	Integer	Connection index

`LR_AddElectricalObjectConnection`#

Connects two electrical objects via cables. Expects an array or a single object with from/to object/line details.

`LR_RemoveElectricalObjectConnection`#

Removes electrical object connections. Expects an array or a single connection specification.

`LR_AddAndRemoveElectricalObjectConnection`#

Add and remove electrical connections in batches.

Parameter	Type	Description
Add	Array	Connections to add
Remove	Array	Connections to remove

`LR_ResolveMultipleOutputUsage`#

Resolves multiple output connections on a connector.

Parameter	Type	Description
ConnectorSelection	Object	Connector info
ObjectList	Array	Object UUIDs

`LR_SetUsedCables`#

Sets selected cables for a connector.

Parameter	Type	Description
Geometry	UUID	Geometriereferenz
SelectedCables	Array	Cable UUIDs

`LR_SetCableColor`#

Sets the color of a cable.

Parameter	Type	Description
UUID	UUID	Cable-UUID
CieColor	String	CIE color value
portName	String	Port name

`LR_GetElectricalObjects`#

Returns circuit-connected objects. Asynchronous.

Parameter	Type	Description
IncludeProperties	Array	Property names to include
CompleteTree	Bool	Include full tree

`LR_GetElectricalGeometries`#

Returns 2D electrical plan geometries. Asynchronous.

Parameter	Type	Description
UUIDs	Array	Object UUIDs to query

`LR_GetCurrentElectricalTree`#

Returns the DMX tree with conflict information. Returns JSON.

`LR_GetCurrentSimpleElectricalTree`#

Returns a simplified electrical tree. Returns JSON.

`LR_ReRunElectricalCalculation`#

Recalculates the electrical routing. No parameters.

12. DMX & Fixtures#

`LR_GetFixtureTypes`#

Lists all available fixture types. Returns JSON.

`LR_GetFixtureTypesFromObject`#

Returns the fixture type for a given object.

Parameter	Type	Description
UUID	UUID	Object

`LR_SetFixtureTypes`#

Assigns fixture types.

Parameter	Type	Description
FixtureTypes	Array	Fixture type assignments

`LR_NumberAllFixtures`#

Automatically numbers fixtures starting from a reference object.

Parameter	Type	Description
UUID	UUID	Startobjekt

`LR_AddNewDmxMode`#

Adds a DMX mode to a fixture type.

Parameter	Type	Description
UUID	UUID	Fixture type
Name	String	Modusname
DmxFootPrint1	Integer	DMX channel footprints
DmxFootPrint2	Integer	DMX channel footprints
DmxFootPrint3	Integer	DMX channel footprints
DmxFootPrint4	Integer	DMX channel footprints

`LR_SetDefaultFixtureType`#

Sets the default fixture type.

Parameter	Type	Description
UUID	UUID	Fixture type

`LR_GetLastFixtureTypes`#

Returns recently used fixture types. Returns JSON.

`LR_GetDmxTree`#

Returns the DMX universe structure. Returns JSON.

`LR_ReplaceSelectedFixtureTypes`#

Replaces fixture types on selected objects. No parameters.

`LR_GetDuplicatedFixtureIDs`#

Searches for duplicate fixture IDs in the drawing. Returns JSON.

`LR_GetDuplicatedObjectIds`#

Searches for duplicate object IDs. Returns JSON.

13. Presets & States#

`LR_AddNewPreset`#

Creates a new preset from the current object state. Returns JSON.

`LR_DeletePreset`#

Removes a preset. Accepts UUID.

`LR_GetPresets`#

Lists all presets. Returns JSON.

`LR_SetPreset`#

Updates preset properties. Expects UUID and property data.

`LR_SetEditablePreset`#

Marks a preset as editable. Returns JSON.

Parameter	Type	Description
UUID	UUID	Preset

`LR_SetActivePreset`#

Enables or disables a preset.

Parameter	Type	Description
UUID	UUID	Preset
Active	Bool	Active state

`LR_SetPresetOrder`#

Changes the order of the presets. Expects an array of UUIDs.

`LR_DeactivatePresets`#

Disables all presets. No parameters.

`LR_RemovePresetEntry`#

Removes an entry from a preset.

Parameter	Type	Description
PresetUUID	UUID	Preset
PropertyName	String	Property to remove
Objects	Array	Affected objects

`LR_GetPresetContent`#

Returns the contents of a preset.

Parameter	Type	Description
UUID	UUID	Preset

`LR_GetAllPresetsContent`#

Returns the contents of all presets. Returns JSON.

`LR_GetAllActiveFixtures`#

Returns all active fixture objects. Returns JSON.

`LR_GetFixturesByAlignment`#

Returns fixtures grouped by orientation. Returns JSON.

14. Worksheets#

`LR_AddNewWorksheet`#

Creates a new worksheet.

Parameter	Type	Description
ObjectUUIDs	Array	Object UUIDs to include (optional)
ObjectUUID	UUID	Single object (optional)
LayerUUID	UUID	Filter by level (optional)
ClassUUID	UUID	Filter by class (optional)
AppendName	String	Append to worksheet name

`LR_DeleteWorksheet`#

Deletes a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet (optional, individual)
UUIDS	Array	Multiple worksheets (optional)

`LR_GetWorksheets`#

Lists all worksheets. Returns JSON.

`LR_GetWorksheetObjects`#

Returns objects on a worksheet. Asynchronous.

Parameter	Type	Description
UUID	UUID	Worksheet
ResolveContainer	Bool	Dissolve containers
IncludeGeometries	Bool	Include geometries

`LR_SetWorksheet`#

Updates worksheet properties.

Parameter	Type	Description
UUID	UUID	Worksheet
Worksheets	Array	UUIDs.Updated data (optional)

`LR_SetWorksheetOrder`#

Changes the order of the worksheets. Expects an array of UUIDs.

`LR_GetWorksheetActivePresets`#

Returns active presets for a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet

`LR_DuplicateWorksheet`#

Clones a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet to duplicate

`LR_CreateAssemblySheetsForGroups`#

Automatically creates assembly worksheets from groups. Expects the object data.

`LR_ShowWorkSheet`#

Displays a worksheet in the user interface.

Parameter	Type	Description
UUID	UUID	Worksheet

`LR_GetForcedWorksheet`#

Returns the UUID of the mandatory worksheet. Returns JSON.

`LR_WorksheetFilterHelper`#

Filters objects for a worksheet. Asynchronous.

Parameter	Type	Description
WorksheetUUID	UUID	Worksheet
UuidToFilter	Array	UUIDs to check
WorksheetViewType	Integer	ViewType

15. Layers#

`LR_AddNewLayer`#

Creates a new layer from the input object. Returns JSON.

`LR_DeleteLayer`#

Deletes a layer. Accepts UUID.

`LR_DeleteLayers`#

Deletes multiple layers. Expects UUIDList (array).

`LR_GetLayer`#

Returns layer information. Accepts UUID. Returns JSON.

`LR_GetLayers`#

Lists all levels. Returns JSON.

`LR_SetLayer`#

Updates a layer.

Parameter	Type	Description
ModifierKey	Bool	Modify key pressed
UUID	UUID	Layer

`LR_SetLayers`#

Updates layers in batches.

Parameter	Type	Description
LayerObjects	Array	Layer data objects

`LR_GetActiveLayer`#

Returns the currently active layer. Returns JSON.

`LR_SetActiveLayer`#

Sets the active layer.

Parameter	Type	Description
Layer	UUID	Layer to activate

16. Classes#

`LR_AddNewClass`#

Creates a new class from the input object. Returns JSON.

`LR_DeleteClass`#

Deletes a class. Accepts UUID.

`LR_DeleteClasses`#

Deletes multiple classes. Expects UUIDList (array).

`LR_GetClass`#

Returns class information. Accepts UUID. Returns JSON.

`LR_GetClasses`#

Lists all classes. Returns JSON.

`LR_SetClass`#

Updates a class.

Parameter	Type	Description
ModifierKey	Bool	Modify key pressed
UUID	UUID	Class

`LR_SetClasses`#

Updates classes in batches.

Parameter	Type	Description
ClassObjects	Array	Class data objects

`LR_GetActiveClass`#

Returns the currently active class. Returns JSON.

`LR_SetActiveClass`#

Sets the active class.

Parameter	Type	Description
Class	UUID	Class to activate

17. Selection Groups#

`LR_AddSelectionGroupForFixturesInLine`#

Creates a selection group of fixtures along a line.

Parameter	Type	Description
Selected	Bool	Use selected objects

`LR_AddNewSelectionGroup`#

Creates a new selection group.

Parameter	Type	Description
PushSelected	Bool	Add selected objects to the group

`LR_DeleteSelectionGroup`#

Deletes a selection group. Accepts UUID.

`LR_GetSelectionGroups`#

Lists all selection groups. Returns JSON.

`LR_AddObjectToSelectionGroup`#

Adds an object to a group.

Parameter	Type	Description
Group	UUID	Auswahlgruppe
Object	UUID	Object to add

`LR_SetSelectionGroup`#

Updates a selection group. Accepts UUID.

18. Inventory: Trucks, Cases & Racks#

`LR_AddNewTruck`#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

`LR_DeleteTruck`#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

`LR_GetTrucks`#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

`LR_GetTruck`#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

`LR_SetTruck`#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

`LR_GetTruckObjects`#

Returns objects assigned to a truck. Asynchronous. Accepts UUID.

`LR_AddNewCase`#

Creates a new case.

Parameter	Type	Description
amountToAdd	Integer	Number of cases to be created

`LR_GetCases`#

CRUD for cases. Accepts UUID for Set/Delete.

`LR_SetCase`#

CRUD for cases. Accepts UUID for Set/Delete.

`LR_DeleteCase`#

CRUD for cases. Accepts UUID for Set/Delete.

`LR_AddNewRack`#

Creates a new rack.

Parameter	Type	Description
RackTemplate	String	Vorlagenname

`LR_GetRacks`#

CRUD for racks. Accepts UUID for Set/Delete.

`LR_SetRack`#

CRUD for racks. Accepts UUID for Set/Delete.

`LR_DeleteRack`#

CRUD for racks. Accepts UUID for Set/Delete.

`LR_GetInventoryData`#

Returns inventory data (grouped). Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root object
WorksheetState	Object	Worksheet configuration
UseGrouping	Bool	Enable grouping

`LR_GetInventorySummery`#

Returns an inventory summary. Asynchronous. No parameters.

`LR_GetInventoryContainerOptions`#

Returns UI options for inventory containers. Returns JSON.

`LR_GetTableViewGroupingData`#

Returns grouped table view data. Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root object
WorksheetState	Object	Configuration
UseGrouping	Bool	Enable grouping

`LR_PackObjectsIntoContainer`#

Automatically packs objects into inventory containers.

Parameter	Type	Description
Container	Array	Container data. UUIDs
Template	String	Vorlagenname
TemplateType	Integer	Vorlagentyp

19. Users#

`LR_AddNewUser`#

Adds a user to the project. Returns JSON.

`LR_GetUsers`#

Lists project users. Returns JSON.

`LR_SetUser`#

Updates a user. Accepts UUID.

`LR_DeleteUser`#

Removes a user. Accepts UUID.

20. Meshes & Textures#

`LR_GetMeshes`#

Lists all meshes.

Parameter	Type	Description
WithCount	Bool	Include usage counters

`LR_GetMesh`#

Returns mesh data. Accepts UUID.

`LR_GetMeshesForResources`#

Returns meshes for resource references.

Parameter	Type	Description
ResourceUUID	UUID	Ressource
ResourceType	Integer	Resource type

`LR_SetMesh`#

Updates a mesh. Accepts UUID.

`LR_SetDefaultMesh`#

Sets a mesh as the default. Accepts UUID. Returns JSON.

`LR_GetTextures`#

Lists all textures. Asynchronous. Returns JSON.

`LR_GetSingleTexture`#

Returns texture data. Asynchronous.

Parameter	Type	Description
UUID	UUID	Textur
Name	String	Texturname

`LR_GetExternalDocuments`#

Lists external documents. Returns JSON.

`LR_DeleteExternalDocument`#

Removes an external document. Accepts UUID.

`LR_SetPreviewTextures`#

Sets textures for preview mode.

Parameter	Type	Description
Textures	Array	Texturdaten

`LR_GetPreviewTextures`#

Returns preview textures.

Parameter	Type	Description
WriteBuffer	Bool	Include buffer data

`LR_GetPreviewTextureFromObject`#

Gets the preview texture of an object.

Parameter	Type	Description
Object	UUID	Objekt
WriteBuffer	Bool	Include buffer data

`LR_DeleteTexture`#

Deletes a texture. Accepts UUID.

`LR_GetReportImage`#

Returns an image used in a calculation or documentation report as base64. Asynchronous.

Parameter	Type	Description
Name	String	Image name (filename relative to the report folder, or 'crossSectionImages/')

21. Import Formats#

`LR_ReadIFC`#

Imports an IFC building model. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional, opens file selection)

`LR_ReadSketchUp`#

Imports a SketchUp file. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)

`LR_ReadDWG`#

Imports an AutoCAD DWG/DXF file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
Scale	Float	Scaling factor
Center	Bool	Center in the drawing

`LR_ReadMVR`#

Imports an MVR file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
SymbolMap	Bool	Apply symbol mapping
ImportGroups	Bool	Import group structure

`LR_ReadPDF`#

Imports a PDF file. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

`LR_ReadMa3Cue`#

Imports a MA3 Cue XML file.

Parameter	Type	Description
Path	String	File path (optional)

`LR_ImportGdtf`#

Imports a GDTF device type file.

Parameter	Type	Description
Path	String	File path (optional)
Last	Bool	Use last import path

`LR_ImportMesh`#

Imports a 3D mesh file.

Parameter	Type	Description
Path	String	File path (optional)

`LR_ImportMeshScene`#

Imports a 3D mesh scene.

Parameter	Type	Description
Path	String	Local file path (optional when Url is provided)
Url	String	URL of the mesh scene to download and import
BackFile	String	Hintergrunddatei
BackUrl	String	URL that receives calculation results via POST

`LR_ImportTexture`#

Imports a texture image.

Parameter	Type	Description
Path	String	File path (optional)
Last	Bool	Use last import path

`LR_ImportExternalDocument`#

Imports an external document.

Parameter	Type	Description
Path	String	File path (optional)

`LR_ImportSVG`#

Imports an SVG graphic. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

`LR_ImportLRWX`#

Imports a LightRight export file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
Checkout	Bool	Check out from server
Project	String	Project (at checkout)
User	String	User (at checkout)
Branch	String	Branch (at checkout)
BranchName	String	Branch display name

`LR_ImportDSTV`#

Imports a DSTV file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

`LR_ImportTradeShowLoadExchange`#

Imports a trade show load exchange file.

Parameter	Type	Description
Path	String	File path
Data	Object	Importdaten
DataArray	Array	Import data array

`LR_ImportPrintLabel`#

Imports a print label file.

Parameter	Type	Description
File	String	File path
UUID	UUID	Designation-UUID

`LR_Import`#

General import function.

Parameter	Type	Description
Path	String	File path (optional)
Type	String	Importtyp

`LR_ReadVectorworksDrawing`#

Reads a Vectorworks drawing. No parameters.

22. Export Formats#

`LR_WriteMVR`#

Exports the drawing to an MVR file.

Parameter	Type	Description
Path	String	Output path (optional, opens file selection)

`LR_WriteCrossSection`#

Exports a truss cross section as JSON.

Parameter	Type	Description
Path	String	Output path (optional)
PayLoad	Object	Querschnittsdaten

`LR_ExportAsGdtf`#

Exported as GDTF device type.

Parameter	Type	Description
Path	String	Output path (optional)

`LR_ExportDSTV`#

Exported in DSTV format.

Parameter	Type	Description
Path	String	Output path (optional)

`LR_ExportIFC`#

Exported in IFC building model format.

Parameter	Type	Description
Path	String	Output path (optional)

`LR_ExportTradeShowLoadExchange`#

Exports trade show load exchange data.

Parameter	Type	Description
Path	String	Ausgabepfad
TradeShowName	String	Name of the fair
Hall	String	Hallenbezeichnung
Booth	String	Standbezeichnung
Company	String	Firmenname

`LR_ExportSymbols`#

Exports the symbol library.

Parameter	Type	Description
Symbols	Array	Symbol-UUIDs
ResourceType	Integer	Resource type (optional)
Path	String	Output path (optional)

`LR_ExportPolygon`#

Exports a polygon as a mesh.

Parameter	Type	Description
Polygon	UUID	Polygon-UUID
Path	String	Output path (optional)

`LR_ExportMeshScene`#

Exports a 3D mesh scene.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exporttyp

`LR_Export`#

General export function.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exporttyp

`LR_WritePngToDisk`#

Saves a PNG image to disk.

Parameter	Type	Description
Path	String	Output path (optional)
Base64	String	Base64 encoded image data

`LR_WriteSvgToDisk`#

Saves an SVG image to disk.

Parameter	Type	Description
Path	String	Output path (optional)
SVG	String	SVG markup

23. Symbol Definitions#

`LR_GetSymbolDefs`#

Lists all symbol definitions. Returns JSON.

`LR_AddNewSymbolDefinition`#

Creates a new symbol definition.

Parameter	Type	Description
UUID	UUID	Predefined UUID (optional)
CopySelected	Bool	Copy from selected objects

`LR_SetSymbolDef`#

Updates a symbol definition. Accepts UUID.

`LR_SetDefaultSymbolDef`#

Sets the default symbol definition. Returns JSON.

Parameter	Type	Description
UUID	UUID	Symbol UUID

`LR_GetLastUsedSymbolDefs`#

Returns recently used symbol definitions. Returns JSON.

`LR_DeleteSymbolContent`#

Deletes all geometry from a symbol definition. Accepts UUID.

`LR_ReplaceSelectedSymbolDefinition`#

Replaces the symbol definition on selected objects. No parameters.

`LR_GenerateNewSymbolUuids`#

Regenerates UUIDs for symbols. No parameters.

`LR_ExplodeObjectSymbolDefinitions`#

Replaces all nested symbol definitions in an object with their actual geometry. Returns JSON (Changed: bool).

Parameter	Type	Description
UUID	UUID	Target object (optional, uses selection if omitted)
Selected	Bool	Use first selected object when UUID is not given

24. Resources & Server Resources#

`LR_GetRessourceDrawing`#

Loads a resource drawing file.

Parameter	Type	Description
File	String	Path to the resource file

`LR_ImportRessource`#

Imports a resource.

Parameter	Type	Description
File	String	File path
UUID	UUID	Resource-UUID

`LR_ImportFixtureType`#

Imports a device type definition.

Parameter	Type	Description
File	String	File path
UUID	UUID	Device type-UUID

`LR_GetServerResource`#

Downloads a resource from the server. Returns JSON.

`LR_GetServerResourceCached`#

Gets a cached server resource. Returns JSON.

`LR_GetServerResourceAsync`#

Asynchronously downloads a resource from the server.

Parameter	Type	Description
Minified	Bool	Use compressed version